wader/fq
1
1
Fork 0
mirror of https://github.com/wader/fq.git synced 2024-12-23 13:22:58 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #119 from wader/doc-more-display-fixes

Browse Source 
doc: More display alias leftover fixes
This commit is contained in:
Mattias Wadman 2022-01-29 16:36:45 +01:00 committed by GitHub
commit e12a14a948
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/dev.md
View File

@ -38,7 +38,7 @@ I ususally use `-d <format>` and `dv` while developing, that way you will get a
even if it fails. `dv` gives verbose output and also includes stacktrace. even if it fails. `dv` gives verbose output and also includes stacktrace.
```sh ```sh
go run fq.go -d <format> v file go run fq.go -d <format> dv file
``` ```
If the format is inside some other format it can be handy to first extract the bits and run If the format is inside some other format it can be handy to first extract the bits and run
@ -46,7 +46,7 @@ the decode directly. For example if working a `aac_frame` decoder issue:
```sh ```sh
fq '.tracks[0].samples[1234] | tobytes' file.mp4 > aac_frame_1234 fq '.tracks[0].samples[1234] | tobytes' file.mp4 > aac_frame_1234
fq -d aac_frame v aac_frame_1234 fq -d aac_frame dv aac_frame_1234
``` ```
Sometimes nested decoding fails then maybe a good way is to change the parent decoder to Sometimes nested decoding fails then maybe a good way is to change the parent decoder to
@ -58,7 +58,7 @@ make things more comfortable. Also using vscode/delve for debugging should work
launch `args` are setup etc. launch `args` are setup etc.
``` ```
watchexec "go run fq.go -d aac_frame v aac_frame" watchexec "go run fq.go -d aac_frame dv aac_frame"
``` ```
Some different ways to run tests: Some different ways to run tests:

8
doc/usage.md
View File

@ -24,14 +24,10 @@ fq 'd({display_bytes: 0})' file
# display 200 bytes for each value # display 200 bytes for each value
fq 'd({display_bytes: 200})' file fq 'd({display_bytes: 200})' file
# recursively display decode tree # recursively display decode tree without truncating
fq f file fq da file
# same as
fq full file
# recursively and verbosely display decode tree # recursively and verbosely display decode tree
fq v file
# same as
fq dv file fq dv file
# JSON repersenation for whole file # JSON repersenation for whole file