From 59b88034d455a8790e2f62391cb317ef59651b05 Mon Sep 17 00:00:00 2001 From: Mattias Wadman Date: Wed, 12 Jan 2022 18:28:02 +0100 Subject: [PATCH] doc: Document dev dependencies and related PRs/issues etc --- README.md | 3 ++- doc/dev.md | 28 +++++++++++++++++++++++++++- 2 files changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index db493e71..d6998dcf 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,8 @@ jq implementation [gojq](https://github.com/itchyny/gojq). I also want to thank [HexFiend](https://github.com/HexFiend/HexFiend) for inspiration and ideas and [stedolan](https://github.com/stedolan) for inventing the [jq](https://github.com/stedolan/jq) language. -Similar or related projects: +### Similar or related projects + - [HexFiend](https://github.com/HexFiend/HexFiend) - [binspector](https://github.com/binspector/binspector) - [kaitai](https://kaitai.io) diff --git a/doc/dev.md b/doc/dev.md index f2cee645..da186775 100644 --- a/doc/dev.md +++ b/doc/dev.md @@ -175,12 +175,38 @@ cd ../fq docker --context 2016-box run --rm -ti -v "C:${PWD//\//\\}:C:${PWD//\//\\}" -w "$PWD" golang:1.17.5-windowsservercore-ltsc2016 ``` -# Implementation details +## Implementation details - fq uses a gojq fork that can be found at https://github.com/wader/gojq/tree/fq (the "fq" branch) - fq uses a readline fork that can be found at https://github.com/wader/readline/tree/fq (the "fq" branch) - cli readline uses raw mode so blocks ctrl-c to become a SIGINT +## Dependencies and source origins + +- [gojq](https://github.com/itchyny/gojq) fork that can be found at https://github.com/wader/gojq/tree/fq
+Issues and PR:s related to fq:
+[#43](https://github.com/itchyny/gojq/issues/43) Support for functions written in go when used as a library
+[#46](https://github.com/itchyny/gojq/pull/46) Support custom internal functions
+[#56](https://github.com/itchyny/gojq/issues/56) String format query with no operator using %#v or %#+v panics +[#65](https://github.com/itchyny/gojq/issues/65) Try-catch with custom function
+[#67](https://github.com/itchyny/gojq/pull/67) Add custom iterator function support which enables implementing a REPL in jq
+[#81](https://github.com/itchyny/gojq/issues/81) path/1 behaviour and path expression question
+[#86](https://github.com/itchyny/gojq/issues/86) ER: basic TCO +[#109](https://github.com/itchyny/gojq/issues/109) jq halt_error behaviour difference
+[#113](https://github.com/itchyny/gojq/issues/113) error/0 and error/1 behavior difference
+[#117](https://github.com/itchyny/gojq/issues/117) Negative number modulus *big.Int behaves differently to int
+[#118](https://github.com/itchyny/gojq/issues/118) Regression introduced by "remove fork analysis from tail call optimization (ref #86)"
+[#122](https://github.com/itchyny/gojq/issues/122) Slow performance for large error values that ends up using typeErrorPreview()
+[#125](https://github.com/itchyny/gojq/pull/125) improve performance of join by make it internal
+[#141](https://github.com/itchyny/gojq/issues/141) Empty array flatten regression since "improve flatten performance by reducing copy" + +- [readline](https://github.com/chzyer/readline) fork that can be found at https://github.com/wader/readline/tree/fq +- [gopacket](https://github.com/google/gopacket) for TCP and IPv4 reassembly +- [mapstructure](https://github.com/mitchellh/mapstructure) for convenient JSON/map conversion +- [go-difflib](https://github.com/pmezard/go-difflib) for diff tests +- [golang.org/x/text](https://pkg.go.dev/golang.org/x/text) for text encoding conversions +- [float16.go](https://android.googlesource.com/platform/tools/gpu/+/gradle_2.0.0/binary/float16.go) to convert bits into 16-bit floats + ## Release process Run and follow instructions: