Fix list inclusions after .adoc renaming #2014
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
This updates
scripts/update-docs.rb
to account for the change in extension (.txt
->.adoc
) when processing include directives during the creation of theen
manual pages.The changes to the generated manual pages can be seen here. I haven't included them in this commit because, looking at the history, it looks like those updates are typically committed separately. Let me know if there's anything else I should do there.
Context
The recent renaming of documentation files from a
.txt
extension to a.adoc
extension broke the generated lists that are included in some of the documentation pages. For example, in the v2.49.0 manual page for git, the sections that are supposed to list all of the subcommands are empty:We are still generating the command lists with the
.txt
extension, but the documentation now uses include directives with the.adoc
extension, and so we are unable to resolve the includes when we want to expand them:The other files affected are
git-config
,git-difftool
, andgit-merge
.Testing
Ran
RERUN=1 ruby ./script/update-docs.rb <path>/git/.git en
and confirmed that the 2.49.0 version of the each of the 4 affected pages was updated. Confirmed that no older version or other manual pages were updated. Viewed the updated pages locally to make sure they now included the lists that had been missing.CC @To1ne