Skip to content

script/update-docs.rb: set {build_dir} correctly #1993

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.

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 1 commit into from
Apr 14, 2025

Conversation

To1ne
Copy link
Collaborator

@To1ne To1ne commented Apr 14, 2025

Changes

Some files use the include:: directive to include content from another
file into the current document. In Git's commit
9219325be74 (Documentation: allow sourcing generated includes from
separate dir, 2024-12-06) the use of {build_dir} was introduced. In
d51c252 (update-docs: accommodate for changes in Git v2.48.0,
2025-01-22) these issues were addressed, but when {build_dir} was used
in a file in a subdir in Documentation/ then this still gets messed up.

Replace {build_dir} by 'Documentation' so including files in {build_dir}
works correctly everywhere.

Fixes #1982

Some files use the `include::` directive to include content from another
file into the current document. In Git's commit
9219325be74 (Documentation: allow sourcing generated includes from
separate dir, 2024-12-06) the use of {build_dir} was introduced. In
d51c252 (update-docs: accommodate for changes in Git v2.48.0,
2025-01-22) these issues were addressed, but when {build_dir} was used
in a file in a subdir in Documentation/ then this still gets messed up.

Replace {build_dir} by 'Documentation' so including files in {build_dir}
works correctly everywhere.

Signed-off-by: Toon Claes <[email protected]>
Copy link
Member

@dscho dscho left a comment

Choose a reason for hiding this comment

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

❤️ Thank you for fixing my bug!

@dscho dscho merged commit 8889c3a into git:gh-pages Apr 14, 2025
1 check passed
@To1ne
Copy link
Collaborator Author

To1ne commented Apr 15, 2025

@To1ne To1ne deleted the toon-fixes-stuff branch April 15, 2025 07:41
@dscho
Copy link
Member

dscho commented Apr 15, 2025

its-working

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Lists of git subcommands missing on git manpage on git-scm.com
2 participants