Skip to content

Fix docs for strptime(fmt) #3164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 27, 2024
Merged

Fix docs for strptime(fmt) #3164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
845dd0f
Fix docs for `strptime(fmt)`
cjlarose Aug 24, 2024
7b15708
Include --enable-docs flag to build docs
cjlarose Aug 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ you have `pipenv` installed, you can install the dependencies by running
Also, you may need to run `virtualenv -p /usr/bin/python3 venv/` and
then `source venv/bin/activate`, and only then `pipenv sync`.

Once this is done, rerun `./configure` in the jq root directory and then
Once this is done, rerun `./configure --enable-docs` in the jq root directory and then
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needed?

Copy link
Contributor Author

@cjlarose cjlarose Aug 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least so far as I understand it, if you don't run ./configure with --enable-docs, then you won't be able to generate the docs at all.

The relevant part of the Makefile.am shows that an error message printed unless ENABLE_DOCS is set.

ENABLE_DOCS is provided by this use of AM_CONDITIONAL in the configure.am described in the GNU automake docs.

Lastly, the GitHub Actions configuration specifies the exact same flag when it's checking if the manpages are up-to-date.

I think it just wasn't really documented anywhere.

the `Makefile` will be able to generate the jq manpage. You can just run
`make jq.1` to build the manpage manually, and `make tests/man.test` to
update the manual tests.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/manual/dev/manual.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2258,7 +2258,7 @@ sections:

The `strptime(fmt)` builtin parses input strings matching the
`fmt` argument. The output is in the "broken down time"
representation consumed by `gmtime` and output by `mktime`.
representation consumed by `mktime` and output by `gmtime`.

The `strftime(fmt)` builtin formats a time (GMT) with the
given format. The `strflocaltime` does the same, but using
Expand Down
2 changes: 1 addition & 1 deletion docs/content/manual/v1.5/manual.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1763,7 +1763,7 @@ sections:

The `strptime(fmt)` builtin parses input strings matching the
`fmt` argument. The output is in the "broken down time"
representation consumed by `gmtime` and output by `mktime`.
representation consumed by `mktime` and output by `gmtime`.

The `strftime(fmt)` builtin formats a time with the given
format.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/manual/v1.6/manual.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1973,7 +1973,7 @@ sections:

The `strptime(fmt)` builtin parses input strings matching the
`fmt` argument. The output is in the "broken down time"
representation consumed by `gmtime` and output by `mktime`.
representation consumed by `mktime` and output by `gmtime`.

The `strftime(fmt)` builtin formats a time (GMT) with the
given format. The `strflocaltime` does the same, but using
Expand Down
2 changes: 1 addition & 1 deletion docs/content/manual/v1.7/manual.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2207,7 +2207,7 @@ sections:

The `strptime(fmt)` builtin parses input strings matching the
`fmt` argument. The output is in the "broken down time"
representation consumed by `gmtime` and output by `mktime`.
representation consumed by `mktime` and output by `gmtime`.

The `strftime(fmt)` builtin formats a time (GMT) with the
given format. The `strflocaltime` does the same, but using
Expand Down
2 changes: 1 addition & 1 deletion jq.1.prebuilt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading