From 41c793eae900e632dbc73ec7f900ea1e7d38aa92 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Sat, 1 Mar 2025 10:36:02 -0500 Subject: doc: update howto-index.sh for .adoc extensions The .txt extensions were changed to .adoc in 1f010d6bdf (doc: use .adoc extension for AsciiDoc files, 2025-01-20). This left broken links in the generated howto-index.html. Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- Documentation/howto/howto-index.sh | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Documentation/howto/howto-index.sh b/Documentation/howto/howto-index.sh index eecd123a93..ace49830a8 100755 --- a/Documentation/howto/howto-index.sh +++ b/Documentation/howto/howto-index.sh @@ -9,9 +9,9 @@ people describing how they use Git in their workflow. EOF -for txt +for adoc do - title=$(expr "$txt" : '.*/\(.*\)\.txt$') + title=$(expr "$adoc" : '.*/\(.*\)\.adoc$') from=$(sed -ne ' /^$/q /^From:[ ]/{ @@ -21,7 +21,7 @@ do s/^/by / p } - ' "$txt") + ' "$adoc") abstract=$(sed -ne ' /^Abstract:[ ]/{ @@ -39,13 +39,13 @@ do x p q - }' "$txt") + }' "$adoc") - if grep 'Content-type: text/asciidoc' >/dev/null $txt + if grep 'Content-type: text/asciidoc' >/dev/null $adoc then - file=$(expr "$txt" : '\(.*\)\.txt$').html + file=$(expr "$adoc" : '\(.*\)\.adoc$').html else - file="$txt" + file="$adoc" fi echo "* link:howto/$(basename "$file")[$title] $from -- cgit v1.3 From fa779fa88d18f550421ae777f7e048dd08ad0006 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Sat, 1 Mar 2025 10:36:03 -0500 Subject: contrib/contacts: rename .txt to .adoc The .txt extensions were changed to .adoc in 1f010d6bdf (doc: use .adoc extension for AsciiDoc files, 2025-01-20). Do the same for contrib/contacts. Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- contrib/contacts/Makefile | 2 +- contrib/contacts/git-contacts.adoc | 94 ++++++++++++++++++++++++++++++++++++++ contrib/contacts/git-contacts.txt | 94 -------------------------------------- contrib/contacts/meson.build | 4 +- 4 files changed, 97 insertions(+), 97 deletions(-) create mode 100644 contrib/contacts/git-contacts.adoc delete mode 100644 contrib/contacts/git-contacts.txt diff --git a/contrib/contacts/Makefile b/contrib/contacts/Makefile index a2990f0dcb..9c4ca4f3bc 100644 --- a/contrib/contacts/Makefile +++ b/contrib/contacts/Makefile @@ -34,7 +34,7 @@ GIT_CONTACTS := git-contacts GIT_CONTACTS_DOC := git-contacts.1 GIT_CONTACTS_XML := git-contacts.xml -GIT_CONTACTS_TXT := git-contacts.txt +GIT_CONTACTS_TXT := git-contacts.adoc GIT_CONTACTS_HTML := git-contacts.html doc: $(GIT_CONTACTS_DOC) $(GIT_CONTACTS_HTML) diff --git a/contrib/contacts/git-contacts.adoc b/contrib/contacts/git-contacts.adoc new file mode 100644 index 0000000000..dd914d1261 --- /dev/null +++ b/contrib/contacts/git-contacts.adoc @@ -0,0 +1,94 @@ +git-contacts(1) +=============== + +NAME +---- +git-contacts - List people who might be interested in a set of changes + + +SYNOPSIS +-------- +[verse] +'git contacts' (||)... + + +DESCRIPTION +----------- + +Given a set of changes, specified as patch files or revisions, determine people +who might be interested in those changes. This is done by consulting the +history of each patch or revision hunk to find people mentioned by commits +which touched the lines of files under consideration. + +Input consists of one or more patch files or revision arguments. A revision +argument can be a range or a single `` which is interpreted as +`..HEAD`, thus the same revision arguments are accepted as for +linkgit:git-format-patch[1]. Patch files and revision arguments can be combined +in the same invocation. + +This command can be useful for determining the list of people with whom to +discuss proposed changes, or for finding the list of recipients to Cc: when +submitting a patch series via `git send-email`. For the latter case, `git +contacts` can be used as the argument to `git send-email`'s `--cc-cmd` option. + + +DISCUSSION +---------- + +`git blame` is invoked for each hunk in a patch file or revision. For each +commit mentioned by `git blame`, the commit message is consulted for people who +authored, reviewed, signed, acknowledged, or were Cc:'d. Once the list of +participants is known, each person's relevance is computed by considering how +many commits mentioned that person compared with the total number of commits +under consideration. The final output consists only of participants who exceed +a minimum threshold of participation. + + +OUTPUT +------ + +For each person of interest, a single line is output, terminated by a newline. +If the person's name is known, ``Name $$$$'' is printed; otherwise +only ``$$$$'' is printed. + + +EXAMPLES +-------- + +* Consult patch files: ++ +------------ +$ git contacts feature/*.patch +------------ + +* Revision range: ++ +------------ +$ git contacts R1..R2 +------------ + +* From a single revision to `HEAD`: ++ +------------ +$ git contacts origin +------------ + +* Helper for `git send-email`: ++ +------------ +$ git send-email --cc-cmd='git contacts' feature/*.patch +------------ + + +LIMITATIONS +----------- + +Several conditions controlling a person's significance are currently +hard-coded, such as minimum participation level (10%), blame date-limiting (5 +years), and `-C` level for detecting moved and copied lines (a single `-C`). In +the future, these conditions may become configurable. + + +GIT +--- +Part of the linkgit:git[1] suite diff --git a/contrib/contacts/git-contacts.txt b/contrib/contacts/git-contacts.txt deleted file mode 100644 index dd914d1261..0000000000 --- a/contrib/contacts/git-contacts.txt +++ /dev/null @@ -1,94 +0,0 @@ -git-contacts(1) -=============== - -NAME ----- -git-contacts - List people who might be interested in a set of changes - - -SYNOPSIS --------- -[verse] -'git contacts' (||)... - - -DESCRIPTION ------------ - -Given a set of changes, specified as patch files or revisions, determine people -who might be interested in those changes. This is done by consulting the -history of each patch or revision hunk to find people mentioned by commits -which touched the lines of files under consideration. - -Input consists of one or more patch files or revision arguments. A revision -argument can be a range or a single `` which is interpreted as -`..HEAD`, thus the same revision arguments are accepted as for -linkgit:git-format-patch[1]. Patch files and revision arguments can be combined -in the same invocation. - -This command can be useful for determining the list of people with whom to -discuss proposed changes, or for finding the list of recipients to Cc: when -submitting a patch series via `git send-email`. For the latter case, `git -contacts` can be used as the argument to `git send-email`'s `--cc-cmd` option. - - -DISCUSSION ----------- - -`git blame` is invoked for each hunk in a patch file or revision. For each -commit mentioned by `git blame`, the commit message is consulted for people who -authored, reviewed, signed, acknowledged, or were Cc:'d. Once the list of -participants is known, each person's relevance is computed by considering how -many commits mentioned that person compared with the total number of commits -under consideration. The final output consists only of participants who exceed -a minimum threshold of participation. - - -OUTPUT ------- - -For each person of interest, a single line is output, terminated by a newline. -If the person's name is known, ``Name $$$$'' is printed; otherwise -only ``$$$$'' is printed. - - -EXAMPLES --------- - -* Consult patch files: -+ ------------- -$ git contacts feature/*.patch ------------- - -* Revision range: -+ ------------- -$ git contacts R1..R2 ------------- - -* From a single revision to `HEAD`: -+ ------------- -$ git contacts origin ------------- - -* Helper for `git send-email`: -+ ------------- -$ git send-email --cc-cmd='git contacts' feature/*.patch ------------- - - -LIMITATIONS ------------ - -Several conditions controlling a person's significance are currently -hard-coded, such as minimum participation level (10%), blame date-limiting (5 -years), and `-C` level for detecting moved and copied lines (a single `-C`). In -the future, these conditions may become configurable. - - -GIT ---- -Part of the linkgit:git[1] suite diff --git a/contrib/contacts/meson.build b/contrib/contacts/meson.build index 6ec92f47c4..73d82dfe52 100644 --- a/contrib/contacts/meson.build +++ b/contrib/contacts/meson.build @@ -16,7 +16,7 @@ if get_option('docs').contains('man') '@INPUT@', ], depends: documentation_deps, - input: 'git-contacts.txt', + input: 'git-contacts.adoc', output: 'git-contacts.xml', ) @@ -47,7 +47,7 @@ if get_option('docs').contains('html') '@INPUT@', ], depends: documentation_deps, - input: 'git-contacts.txt', + input: 'git-contacts.adoc', output: 'git-contacts.html', install: true, install_dir: get_option('datadir') / 'doc/git-doc', -- cgit v1.3 From 561de07b57fcc2057fb6b96043f008a5b83f140c Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Sat, 1 Mar 2025 10:36:04 -0500 Subject: contrib/subtree: rename .txt to .adoc The .txt extensions were changed to .adoc in 1f010d6bdf (doc: use .adoc extension for AsciiDoc files, 2025-01-20). Do the same for contrib/subtree. Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- contrib/subtree/Makefile | 2 +- contrib/subtree/git-subtree.adoc | 353 +++++++++++++++++++++++++++++++++++++++ contrib/subtree/git-subtree.txt | 353 --------------------------------------- contrib/subtree/meson.build | 4 +- 4 files changed, 356 insertions(+), 356 deletions(-) create mode 100644 contrib/subtree/git-subtree.adoc delete mode 100644 contrib/subtree/git-subtree.txt diff --git a/contrib/subtree/Makefile b/contrib/subtree/Makefile index 8fe0bfd401..c0c9f21cb7 100644 --- a/contrib/subtree/Makefile +++ b/contrib/subtree/Makefile @@ -50,7 +50,7 @@ GIT_SUBTREE := git-subtree GIT_SUBTREE_DOC := git-subtree.1 GIT_SUBTREE_XML := git-subtree.xml -GIT_SUBTREE_TXT := git-subtree.txt +GIT_SUBTREE_TXT := git-subtree.adoc GIT_SUBTREE_HTML := git-subtree.html GIT_SUBTREE_TEST := ../../git-subtree diff --git a/contrib/subtree/git-subtree.adoc b/contrib/subtree/git-subtree.adoc new file mode 100644 index 0000000000..004abf415b --- /dev/null +++ b/contrib/subtree/git-subtree.adoc @@ -0,0 +1,353 @@ +git-subtree(1) +============== + +NAME +---- +git-subtree - Merge subtrees together and split repository into subtrees + + +SYNOPSIS +-------- +[verse] +'git subtree' [] -P add +'git subtree' [] -P add +'git subtree' [] -P merge [] +'git subtree' [] -P split [] + +[verse] +'git subtree' [] -P pull +'git subtree' [] -P push + +DESCRIPTION +----------- +Subtrees allow subprojects to be included within a subdirectory +of the main project, optionally including the subproject's +entire history. + +For example, you could include the source code for a library +as a subdirectory of your application. + +Subtrees are not to be confused with submodules, which are meant for +the same task. Unlike submodules, subtrees do not need any special +constructions (like '.gitmodules' files or gitlinks) be present in +your repository, and do not force end-users of your +repository to do anything special or to understand how subtrees +work. A subtree is just a subdirectory that can be +committed to, branched, and merged along with your project in +any way you want. + +They are also not to be confused with using the subtree merge +strategy. The main difference is that, besides merging +the other project as a subdirectory, you can also extract the +entire history of a subdirectory from your project and make it +into a standalone project. Unlike the subtree merge strategy +you can alternate back and forth between these +two operations. If the standalone library gets updated, you can +automatically merge the changes into your project; if you +update the library inside your project, you can "split" the +changes back out again and merge them back into the library +project. + +For example, if a library you made for one application ends up being +useful elsewhere, you can extract its entire history and publish +that as its own git repository, without accidentally +intermingling the history of your application project. + +[TIP] +In order to keep your commit messages clean, we recommend that +people split their commits between the subtrees and the main +project as much as possible. That is, if you make a change that +affects both the library and the main application, commit it in +two pieces. That way, when you split the library commits out +later, their descriptions will still make sense. But if this +isn't important to you, it's not *necessary*. 'git subtree' will +simply leave out the non-library-related parts of the commit +when it splits it out into the subproject later. + + +COMMANDS +-------- +add :: +add :: + Create the subtree by importing its contents + from the given or and . + A new commit is created automatically, joining the imported + project's history with your own. With '--squash', import + only a single commit from the subproject, rather than its + entire history. + +merge []:: + Merge recent changes up to into the + subtree. As with normal 'git merge', this doesn't + remove your own local changes; it just merges those + changes into the latest . With '--squash', + create only one commit that contains all the changes, + rather than merging in the entire history. ++ +If you use '--squash', the merge direction doesn't always have to be +forward; you can use this command to go back in time from v2.5 to v2.4, +for example. If your merge introduces a conflict, you can resolve it in +the usual ways. ++ +When using '--squash', and the previous merge with '--squash' merged an +annotated tag of the subtree repository, that tag needs to be available locally. +If is given, a missing tag will automatically be fetched from that +repository. + +split [] []:: + Extract a new, synthetic project history from the + history of the subtree of , or of + HEAD if no is given. The new history + includes only the commits (including merges) that + affected , and each of those commits now has the + contents of at the root of the project instead + of in a subdirectory. Thus, the newly created history + is suitable for export as a separate git repository. ++ +After splitting successfully, a single commit ID is printed to stdout. +This corresponds to the HEAD of the newly created tree, which you can +manipulate however you want. ++ +Repeated splits of exactly the same history are guaranteed to be +identical (i.e. to produce the same commit IDs) as long as the +settings passed to 'split' (such as '--annotate') are the same. +Because of this, if you add new commits and then re-split, the new +commits will be attached as commits on top of the history you +generated last time, so 'git merge' and friends will work as expected. ++ +When a previous merge with '--squash' merged an annotated tag of the +subtree repository, that tag needs to be available locally. +If is given, a missing tag will automatically be fetched from that +repository. + +pull :: + Exactly like 'merge', but parallels 'git pull' in that + it fetches the given ref from the specified remote + repository. + +push [+][:]:: + Does a 'split' using the subtree of + and then does a 'git push' to push the result to the + and . This can be used to push your + subtree to different branches of the remote repository. Just + as with 'split', if no is given, then HEAD is + used. The optional leading '+' is ignored. + +OPTIONS FOR ALL COMMANDS +------------------------ +-q:: +--quiet:: + Suppress unnecessary output messages on stderr. + +-d:: +--debug:: + Produce even more unnecessary output messages on stderr. + +-P :: +--prefix=:: + Specify the path in the repository to the subtree you + want to manipulate. This option is mandatory + for all commands. + +OPTIONS FOR 'add' AND 'merge' (ALSO: 'pull', 'split --rejoin', AND 'push --rejoin') +----------------------------------------------------------------------------------- +These options for 'add' and 'merge' may also be given to 'pull' (which +wraps 'merge'), 'split --rejoin' (which wraps either 'add' or 'merge' +as appropriate), and 'push --rejoin' (which wraps 'split --rejoin'). + +--squash:: + Instead of merging the entire history from the subtree project, produce + only a single commit that contains all the differences you want to + merge, and then merge that new commit into your project. ++ +Using this option helps to reduce log clutter. People rarely want to see +every change that happened between v1.0 and v1.1 of the library they're +using, since none of the interim versions were ever included in their +application. ++ +Using '--squash' also helps avoid problems when the same subproject is +included multiple times in the same project, or is removed and then +re-added. In such a case, it doesn't make sense to combine the +histories anyway, since it's unclear which part of the history belongs +to which subtree. ++ +Furthermore, with '--squash', you can switch back and forth between +different versions of a subtree, rather than strictly forward. 'git +subtree merge --squash' always adjusts the subtree to match the exactly +specified commit, even if getting to that commit would require undoing +some changes that were added earlier. ++ +Whether or not you use '--squash', changes made in your local repository +remain intact and can be later split and send upstream to the +subproject. + +-m :: +--message=:: + Specify as the commit message for the merge commit. + +OPTIONS FOR 'split' (ALSO: 'push') +---------------------------------- +These options for 'split' may also be given to 'push' (which wraps +'split'). + +--annotate=:: + When generating synthetic history, add as a prefix to each + commit message. Since we're creating new commits with the same commit + message, but possibly different content, from the original commits, this + can help to differentiate them and avoid confusion. ++ +Whenever you split, you need to use the same , or else you +don't have a guarantee that the new re-created history will be identical +to the old one. That will prevent merging from working correctly. git +subtree tries to make it work anyway, particularly if you use '--rejoin', +but it may not always be effective. + +-b :: +--branch=:: + After generating the synthetic history, create a new branch called + that contains the new history. This is suitable for immediate + pushing upstream. must not already exist. + +--ignore-joins:: + If you use '--rejoin', git subtree attempts to optimize its history + reconstruction to generate only the new commits since the last + '--rejoin'. '--ignore-joins' disables this behavior, forcing it to + regenerate the entire history. In a large project, this can take a long + time. + +--onto=:: + If your subtree was originally imported using something other than git + subtree, its history may not match what git subtree is expecting. In + that case, you can specify the commit ID that corresponds to the + first revision of the subproject's history that was imported into your + project, and git subtree will attempt to build its history from there. ++ +If you used 'git subtree add', you should never need this option. + +--rejoin:: + After splitting, merge the newly created synthetic history back into + your main project. That way, future splits can search only the part of + history that has been added since the most recent '--rejoin'. ++ +If your split commits end up merged into the upstream subproject, and +then you want to get the latest upstream version, this will allow git's +merge algorithm to more intelligently avoid conflicts (since it knows +these synthetic commits are already part of the upstream repository). ++ +Unfortunately, using this option results in 'git log' showing an extra +copy of every new commit that was created (the original, and the +synthetic one). ++ +If you do all your merges with '--squash', make sure you also use +'--squash' when you 'split --rejoin'. + + +EXAMPLE 1. 'add' command +------------------------ +Let's assume that you have a local repository that you would like +to add an external vendor library to. In this case we will add the +git-subtree repository as a subdirectory of your already existing +git-extensions repository in ~/git-extensions/: + + $ git subtree add --prefix=git-subtree --squash \ + git://github.com/apenwarr/git-subtree.git master + +'master' needs to be a valid remote ref and can be a different branch +name + +You can omit the '--squash' flag, but doing so will increase the number +of commits that are included in your local repository. + +We now have a ~/git-extensions/git-subtree directory containing code +from the master branch of git://github.com/apenwarr/git-subtree.git +in our git-extensions repository. + +EXAMPLE 2. Extract a subtree using 'commit', 'merge' and 'pull' +--------------------------------------------------------------- +Let's use the repository for the git source code as an example. +First, get your own copy of the git.git repository: + + $ git clone git://git.kernel.org/pub/scm/git/git.git test-git + $ cd test-git + +gitweb (commit 1130ef3) was merged into git as of commit +0a8f4f0, after which it was no longer maintained separately. +But imagine it had been maintained separately, and we wanted to +extract git's changes to gitweb since that time, to share with +the upstream. You could do this: + + $ git subtree split --prefix=gitweb --annotate='(split) ' \ + 0a8f4f0^.. --onto=1130ef3 --rejoin \ + --branch gitweb-latest + $ gitk gitweb-latest + $ git push git@github.com:whatever/gitweb.git gitweb-latest:master + +(We use '0a8f4f0^..' because that means "all the changes from +0a8f4f0 to the current version, including 0a8f4f0 itself.") + +If gitweb had originally been merged using 'git subtree add' (or +a previous split had already been done with '--rejoin' specified) +then you can do all your splits without having to remember any +weird commit IDs: + + $ git subtree split --prefix=gitweb --annotate='(split) ' --rejoin \ + --branch gitweb-latest2 + +And you can merge changes back in from the upstream project just +as easily: + + $ git subtree pull --prefix=gitweb \ + git@github.com:whatever/gitweb.git master + +Or, using '--squash', you can actually rewind to an earlier +version of gitweb: + + $ git subtree merge --prefix=gitweb --squash gitweb-latest~10 + +Then make some changes: + + $ date >gitweb/myfile + $ git add gitweb/myfile + $ git commit -m 'created myfile' + +And fast forward again: + + $ git subtree merge --prefix=gitweb --squash gitweb-latest + +And notice that your change is still intact: + + $ ls -l gitweb/myfile + +And you can split it out and look at your changes versus +the standard gitweb: + + git log gitweb-latest..$(git subtree split --prefix=gitweb) + +EXAMPLE 3. Extract a subtree using a branch +------------------------------------------- +Suppose you have a source directory with many files and +subdirectories, and you want to extract the lib directory to its own +git project. Here's a short way to do it: + +First, make the new repository wherever you want: + + $ + $ git init --bare + +Back in your original directory: + + $ git subtree split --prefix=lib --annotate="(split)" -b split + +Then push the new branch onto the new empty repository: + + $ git push split:master + + +AUTHOR +------ +Written by Avery Pennarun + + +GIT +--- +Part of the linkgit:git[1] suite diff --git a/contrib/subtree/git-subtree.txt b/contrib/subtree/git-subtree.txt deleted file mode 100644 index 004abf415b..0000000000 --- a/contrib/subtree/git-subtree.txt +++ /dev/null @@ -1,353 +0,0 @@ -git-subtree(1) -============== - -NAME ----- -git-subtree - Merge subtrees together and split repository into subtrees - - -SYNOPSIS --------- -[verse] -'git subtree' [] -P add -'git subtree' [] -P add -'git subtree' [] -P merge [] -'git subtree' [] -P split [] - -[verse] -'git subtree' [] -P pull -'git subtree' [] -P push - -DESCRIPTION ------------ -Subtrees allow subprojects to be included within a subdirectory -of the main project, optionally including the subproject's -entire history. - -For example, you could include the source code for a library -as a subdirectory of your application. - -Subtrees are not to be confused with submodules, which are meant for -the same task. Unlike submodules, subtrees do not need any special -constructions (like '.gitmodules' files or gitlinks) be present in -your repository, and do not force end-users of your -repository to do anything special or to understand how subtrees -work. A subtree is just a subdirectory that can be -committed to, branched, and merged along with your project in -any way you want. - -They are also not to be confused with using the subtree merge -strategy. The main difference is that, besides merging -the other project as a subdirectory, you can also extract the -entire history of a subdirectory from your project and make it -into a standalone project. Unlike the subtree merge strategy -you can alternate back and forth between these -two operations. If the standalone library gets updated, you can -automatically merge the changes into your project; if you -update the library inside your project, you can "split" the -changes back out again and merge them back into the library -project. - -For example, if a library you made for one application ends up being -useful elsewhere, you can extract its entire history and publish -that as its own git repository, without accidentally -intermingling the history of your application project. - -[TIP] -In order to keep your commit messages clean, we recommend that -people split their commits between the subtrees and the main -project as much as possible. That is, if you make a change that -affects both the library and the main application, commit it in -two pieces. That way, when you split the library commits out -later, their descriptions will still make sense. But if this -isn't important to you, it's not *necessary*. 'git subtree' will -simply leave out the non-library-related parts of the commit -when it splits it out into the subproject later. - - -COMMANDS --------- -add :: -add :: - Create the subtree by importing its contents - from the given or and . - A new commit is created automatically, joining the imported - project's history with your own. With '--squash', import - only a single commit from the subproject, rather than its - entire history. - -merge []:: - Merge recent changes up to into the - subtree. As with normal 'git merge', this doesn't - remove your own local changes; it just merges those - changes into the latest . With '--squash', - create only one commit that contains all the changes, - rather than merging in the entire history. -+ -If you use '--squash', the merge direction doesn't always have to be -forward; you can use this command to go back in time from v2.5 to v2.4, -for example. If your merge introduces a conflict, you can resolve it in -the usual ways. -+ -When using '--squash', and the previous merge with '--squash' merged an -annotated tag of the subtree repository, that tag needs to be available locally. -If is given, a missing tag will automatically be fetched from that -repository. - -split [] []:: - Extract a new, synthetic project history from the - history of the subtree of , or of - HEAD if no is given. The new history - includes only the commits (including merges) that - affected , and each of those commits now has the - contents of at the root of the project instead - of in a subdirectory. Thus, the newly created history - is suitable for export as a separate git repository. -+ -After splitting successfully, a single commit ID is printed to stdout. -This corresponds to the HEAD of the newly created tree, which you can -manipulate however you want. -+ -Repeated splits of exactly the same history are guaranteed to be -identical (i.e. to produce the same commit IDs) as long as the -settings passed to 'split' (such as '--annotate') are the same. -Because of this, if you add new commits and then re-split, the new -commits will be attached as commits on top of the history you -generated last time, so 'git merge' and friends will work as expected. -+ -When a previous merge with '--squash' merged an annotated tag of the -subtree repository, that tag needs to be available locally. -If is given, a missing tag will automatically be fetched from that -repository. - -pull :: - Exactly like 'merge', but parallels 'git pull' in that - it fetches the given ref from the specified remote - repository. - -push [+][:]:: - Does a 'split' using the subtree of - and then does a 'git push' to push the result to the - and . This can be used to push your - subtree to different branches of the remote repository. Just - as with 'split', if no is given, then HEAD is - used. The optional leading '+' is ignored. - -OPTIONS FOR ALL COMMANDS ------------------------- --q:: ---quiet:: - Suppress unnecessary output messages on stderr. - --d:: ---debug:: - Produce even more unnecessary output messages on stderr. - --P :: ---prefix=:: - Specify the path in the repository to the subtree you - want to manipulate. This option is mandatory - for all commands. - -OPTIONS FOR 'add' AND 'merge' (ALSO: 'pull', 'split --rejoin', AND 'push --rejoin') ------------------------------------------------------------------------------------ -These options for 'add' and 'merge' may also be given to 'pull' (which -wraps 'merge'), 'split --rejoin' (which wraps either 'add' or 'merge' -as appropriate), and 'push --rejoin' (which wraps 'split --rejoin'). - ---squash:: - Instead of merging the entire history from the subtree project, produce - only a single commit that contains all the differences you want to - merge, and then merge that new commit into your project. -+ -Using this option helps to reduce log clutter. People rarely want to see -every change that happened between v1.0 and v1.1 of the library they're -using, since none of the interim versions were ever included in their -application. -+ -Using '--squash' also helps avoid problems when the same subproject is -included multiple times in the same project, or is removed and then -re-added. In such a case, it doesn't make sense to combine the -histories anyway, since it's unclear which part of the history belongs -to which subtree. -+ -Furthermore, with '--squash', you can switch back and forth between -different versions of a subtree, rather than strictly forward. 'git -subtree merge --squash' always adjusts the subtree to match the exactly -specified commit, even if getting to that commit would require undoing -some changes that were added earlier. -+ -Whether or not you use '--squash', changes made in your local repository -remain intact and can be later split and send upstream to the -subproject. - --m :: ---message=:: - Specify as the commit message for the merge commit. - -OPTIONS FOR 'split' (ALSO: 'push') ----------------------------------- -These options for 'split' may also be given to 'push' (which wraps -'split'). - ---annotate=:: - When generating synthetic history, add as a prefix to each - commit message. Since we're creating new commits with the same commit - message, but possibly different content, from the original commits, this - can help to differentiate them and avoid confusion. -+ -Whenever you split, you need to use the same , or else you -don't have a guarantee that the new re-created history will be identical -to the old one. That will prevent merging from working correctly. git -subtree tries to make it work anyway, particularly if you use '--rejoin', -but it may not always be effective. - --b :: ---branch=:: - After generating the synthetic history, create a new branch called - that contains the new history. This is suitable for immediate - pushing upstream. must not already exist. - ---ignore-joins:: - If you use '--rejoin', git subtree attempts to optimize its history - reconstruction to generate only the new commits since the last - '--rejoin'. '--ignore-joins' disables this behavior, forcing it to - regenerate the entire history. In a large project, this can take a long - time. - ---onto=:: - If your subtree was originally imported using something other than git - subtree, its history may not match what git subtree is expecting. In - that case, you can specify the commit ID that corresponds to the - first revision of the subproject's history that was imported into your - project, and git subtree will attempt to build its history from there. -+ -If you used 'git subtree add', you should never need this option. - ---rejoin:: - After splitting, merge the newly created synthetic history back into - your main project. That way, future splits can search only the part of - history that has been added since the most recent '--rejoin'. -+ -If your split commits end up merged into the upstream subproject, and -then you want to get the latest upstream version, this will allow git's -merge algorithm to more intelligently avoid conflicts (since it knows -these synthetic commits are already part of the upstream repository). -+ -Unfortunately, using this option results in 'git log' showing an extra -copy of every new commit that was created (the original, and the -synthetic one). -+ -If you do all your merges with '--squash', make sure you also use -'--squash' when you 'split --rejoin'. - - -EXAMPLE 1. 'add' command ------------------------- -Let's assume that you have a local repository that you would like -to add an external vendor library to. In this case we will add the -git-subtree repository as a subdirectory of your already existing -git-extensions repository in ~/git-extensions/: - - $ git subtree add --prefix=git-subtree --squash \ - git://github.com/apenwarr/git-subtree.git master - -'master' needs to be a valid remote ref and can be a different branch -name - -You can omit the '--squash' flag, but doing so will increase the number -of commits that are included in your local repository. - -We now have a ~/git-extensions/git-subtree directory containing code -from the master branch of git://github.com/apenwarr/git-subtree.git -in our git-extensions repository. - -EXAMPLE 2. Extract a subtree using 'commit', 'merge' and 'pull' ---------------------------------------------------------------- -Let's use the repository for the git source code as an example. -First, get your own copy of the git.git repository: - - $ git clone git://git.kernel.org/pub/scm/git/git.git test-git - $ cd test-git - -gitweb (commit 1130ef3) was merged into git as of commit -0a8f4f0, after which it was no longer maintained separately. -But imagine it had been maintained separately, and we wanted to -extract git's changes to gitweb since that time, to share with -the upstream. You could do this: - - $ git subtree split --prefix=gitweb --annotate='(split) ' \ - 0a8f4f0^.. --onto=1130ef3 --rejoin \ - --branch gitweb-latest - $ gitk gitweb-latest - $ git push git@github.com:whatever/gitweb.git gitweb-latest:master - -(We use '0a8f4f0^..' because that means "all the changes from -0a8f4f0 to the current version, including 0a8f4f0 itself.") - -If gitweb had originally been merged using 'git subtree add' (or -a previous split had already been done with '--rejoin' specified) -then you can do all your splits without having to remember any -weird commit IDs: - - $ git subtree split --prefix=gitweb --annotate='(split) ' --rejoin \ - --branch gitweb-latest2 - -And you can merge changes back in from the upstream project just -as easily: - - $ git subtree pull --prefix=gitweb \ - git@github.com:whatever/gitweb.git master - -Or, using '--squash', you can actually rewind to an earlier -version of gitweb: - - $ git subtree merge --prefix=gitweb --squash gitweb-latest~10 - -Then make some changes: - - $ date >gitweb/myfile - $ git add gitweb/myfile - $ git commit -m 'created myfile' - -And fast forward again: - - $ git subtree merge --prefix=gitweb --squash gitweb-latest - -And notice that your change is still intact: - - $ ls -l gitweb/myfile - -And you can split it out and look at your changes versus -the standard gitweb: - - git log gitweb-latest..$(git subtree split --prefix=gitweb) - -EXAMPLE 3. Extract a subtree using a branch -------------------------------------------- -Suppose you have a source directory with many files and -subdirectories, and you want to extract the lib directory to its own -git project. Here's a short way to do it: - -First, make the new repository wherever you want: - - $ - $ git init --bare - -Back in your original directory: - - $ git subtree split --prefix=lib --annotate="(split)" -b split - -Then push the new branch onto the new empty repository: - - $ git push split:master - - -AUTHOR ------- -Written by Avery Pennarun - - -GIT ---- -Part of the linkgit:git[1] suite diff --git a/contrib/subtree/meson.build b/contrib/subtree/meson.build index a752a188df..9c72b23625 100644 --- a/contrib/subtree/meson.build +++ b/contrib/subtree/meson.build @@ -32,7 +32,7 @@ if get_option('docs').contains('man') '@INPUT@', ], depends: documentation_deps, - input: 'git-subtree.txt', + input: 'git-subtree.adoc', output: 'git-subtree.xml', ) @@ -63,7 +63,7 @@ if get_option('docs').contains('html') '@INPUT@', ], depends: documentation_deps, - input: 'git-subtree.txt', + input: 'git-subtree.adoc', output: 'git-subtree.html', install: true, install_dir: get_option('datadir') / 'doc/git-doc', -- cgit v1.3 From 06d9252bccc39c335fa5ab36adf724df4570248c Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Sat, 1 Mar 2025 10:25:10 -0800 Subject: doc: fix build-docdep.perl We renamed from .txt to .adoc all the asciidoc source files and necessary includes. We also need to adjust the build-docdep tool to work on files whose suffix is .adoc when computing the documentation dependencies. Signed-off-by: Junio C Hamano --- Documentation/build-docdep.perl | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/Documentation/build-docdep.perl b/Documentation/build-docdep.perl index 315efaa2fa..781da12b2e 100755 --- a/Documentation/build-docdep.perl +++ b/Documentation/build-docdep.perl @@ -4,15 +4,15 @@ my ($build_dir) = @ARGV; my %include = (); my %included = (); -for my $text (<*.txt>) { - open I, '<', $text || die "cannot read: $text"; +for my $adoc (<*.adoc>) { + open I, '<', $adoc || die "cannot read: $adoc"; while () { if (/^include::/) { chomp; s/^include::\s*//; s/\[\]//; s/{build_dir}/${build_dir}/; - $include{$text}{$_} = 1; + $include{$adoc}{$_} = 1; $included{$_} = 1; } } @@ -23,14 +23,14 @@ for my $text (<*.txt>) { my $changed = 1; while ($changed) { $changed = 0; - while (my ($text, $included) = each %include) { + while (my ($adoc, $included) = each %include) { for my $i (keys %$included) { - # $text has include::$i; if $i includes $j - # $text indirectly includes $j. + # $adoc has include::$i; if $i includes $j + # $adoc indirectly includes $j. if (exists $include{$i}) { for my $j (keys %{$include{$i}}) { - if (!exists $include{$text}{$j}) { - $include{$text}{$j} = 1; + if (!exists $include{$adoc}{$j}) { + $include{$adoc}{$j} = 1; $included{$j} = 1; $changed = 1; } @@ -40,10 +40,10 @@ while ($changed) { } } -foreach my $text (sort keys %include) { - my $included = $include{$text}; - if (! exists $included{$text} && - (my $base = $text) =~ s/\.txt$//) { +foreach my $adoc (sort keys %include) { + my $included = $include{$adoc}; + if (! exists $included{$adoc} && + (my $base = $adoc) =~ s/\.adoc$//) { print "$base.html $base.xml : ", join(" ", sort keys %$included), "\n"; } } -- cgit v1.3 From 82deaae3b94d59caf13ea21c980ab386df6dac9e Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:43:59 -0500 Subject: t0450: *.txt -> *.adoc fixes After 1f010d6bdf (doc: use .adoc extension for AsciiDoc files, 2025-01-20), we no longer matched any files in this test. The result is that we did not test for mismatches in the documentation and --help output. Adjust the test to look at the renamed *.adoc files. Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- t/t0450-txt-doc-vs-help.sh | 50 +++++++++++++++++++-------------------- t/t0450/adoc-help-mismatches | 56 ++++++++++++++++++++++++++++++++++++++++++++ t/t0450/txt-help-mismatches | 56 -------------------------------------------- 3 files changed, 81 insertions(+), 81 deletions(-) create mode 100644 t/t0450/adoc-help-mismatches delete mode 100644 t/t0450/txt-help-mismatches diff --git a/t/t0450-txt-doc-vs-help.sh b/t/t0450-txt-doc-vs-help.sh index 853101b86e..2f7504ae7e 100755 --- a/t/t0450-txt-doc-vs-help.sh +++ b/t/t0450-txt-doc-vs-help.sh @@ -1,6 +1,6 @@ #!/bin/sh -test_description='assert (unbuilt) Documentation/*.txt and -h output +test_description='assert (unbuilt) Documentation/*.adoc and -h output Run this with --debug to see a summary of where we still fail to make the two versions consistent with one another.' @@ -11,11 +11,11 @@ test_expect_success 'setup: list of builtins' ' git --list-cmds=builtins >builtins ' -test_expect_success 'list of txt and help mismatches is sorted' ' - sort -u "$TEST_DIRECTORY"/t0450/txt-help-mismatches >expect && - if ! test_cmp expect "$TEST_DIRECTORY"/t0450/txt-help-mismatches +test_expect_success 'list of adoc and help mismatches is sorted' ' + sort -u "$TEST_DIRECTORY"/t0450/adoc-help-mismatches >expect && + if ! test_cmp expect "$TEST_DIRECTORY"/t0450/adoc-help-mismatches then - BUG "please keep the list of txt and help mismatches sorted" + BUG "please keep the list of adoc and help mismatches sorted" fi ' @@ -40,20 +40,20 @@ help_to_synopsis () { echo "$out" } -builtin_to_txt () { - echo "$GIT_BUILD_DIR/Documentation/git-$1.txt" +builtin_to_adoc () { + echo "$GIT_BUILD_DIR/Documentation/git-$1.adoc" } -txt_to_synopsis () { +adoc_to_synopsis () { builtin="$1" && out_dir="out/$builtin" && - out="$out_dir/txt.synopsis" && + out="$out_dir/adoc.synopsis" && if test -f "$out" then echo "$out" && return 0 fi && - b2t="$(builtin_to_txt "$builtin")" && + b2t="$(builtin_to_adoc "$builtin")" && sed -n \ -E '/^\[(verse|synopsis)\]$/,/^$/ { /^$/d; @@ -109,29 +109,29 @@ do fi ' - txt="$(builtin_to_txt "$builtin")" && - preq="$(echo BUILTIN_TXT_$builtin | tr '[:lower:]-' '[:upper:]_')" && + adoc="$(builtin_to_adoc "$builtin")" && + preq="$(echo BUILTIN_ADOC_$builtin | tr '[:lower:]-' '[:upper:]_')" && - if test -f "$txt" + if test -f "$adoc" then test_set_prereq "$preq" fi && - # *.txt output assertions - test_expect_success "$preq" "$builtin *.txt SYNOPSIS has dashed labels" ' - check_dashed_labels "$(txt_to_synopsis "$builtin")" + # *.adoc output assertions + test_expect_success "$preq" "$builtin *.adoc SYNOPSIS has dashed labels" ' + check_dashed_labels "$(adoc_to_synopsis "$builtin")" ' - # *.txt output consistency assertions + # *.adoc output consistency assertions result= - if grep -q "^$builtin$" "$TEST_DIRECTORY"/t0450/txt-help-mismatches + if grep -q "^$builtin$" "$TEST_DIRECTORY"/t0450/adoc-help-mismatches then result=failure else result=success fi && test_expect_$result "$preq" "$builtin -h output and SYNOPSIS agree" ' - t2s="$(txt_to_synopsis "$builtin")" && + t2s="$(adoc_to_synopsis "$builtin")" && if test "$builtin" = "merge-tree" then test_when_finished "rm -f t2s.new" && @@ -140,17 +140,17 @@ do fi && h2s="$(help_to_synopsis "$builtin")" && - # The *.txt and -h use different spacing for the + # The *.adoc and -h use different spacing for the # alignment of continued usage output, normalize it. - align_after_nl "$builtin" <"$t2s" >txt && + align_after_nl "$builtin" <"$t2s" >adoc && align_after_nl "$builtin" <"$h2s" >help && - test_cmp txt help + test_cmp adoc help ' - if test_have_prereq "$preq" && test -e txt && test -e help + if test_have_prereq "$preq" && test -e adoc && test -e help then test_debug ' - if test_cmp txt help >cmp 2>/dev/null + if test_cmp adoc help >cmp 2>/dev/null then echo "=== DONE: $builtin ===" else @@ -161,7 +161,7 @@ do # Not in test_expect_success in case --run is being # used with --debug - rm -f txt help tmp 2>/dev/null + rm -f adoc help tmp 2>/dev/null fi done Date: Mon, 3 Mar 2025 15:44:00 -0500 Subject: .gitattributes: more *.txt -> *.adoc updates All Documentation files now end in .adoc. Update the entries for git-merge.adoc, gitk.adoc, and user-manual.adoc to properly set the conflict-marker-size attribute. Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- .gitattributes | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.gitattributes b/.gitattributes index 43fa883a84..c6a0b35116 100644 --- a/.gitattributes +++ b/.gitattributes @@ -12,7 +12,7 @@ CODE_OF_CONDUCT.md -whitespace /GIT-VERSION-GEN text eol=lf /mergetools/* text eol=lf /t/oid-info/* text eol=lf -/Documentation/git-merge.txt conflict-marker-size=32 -/Documentation/gitk.txt conflict-marker-size=32 -/Documentation/user-manual.txt conflict-marker-size=32 +/Documentation/git-merge.adoc conflict-marker-size=32 +/Documentation/gitk.adoc conflict-marker-size=32 +/Documentation/user-manual.adoc conflict-marker-size=32 /t/t????-*.sh conflict-marker-size=32 -- cgit v1.3 From 7d90a272ac4f9a2755d7b4f5807d670e0212e70f Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:01 -0500 Subject: doc: remove unneeded .gitattributes The top-level .gitattributes file contains entries for the Documentation tree. Documentation/.gitattributes has not been touched since it was added in 14f9e128d3 (Define the project whitespace policy, 2008-02-10). Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- Documentation/.gitattributes | 1 - 1 file changed, 1 deletion(-) delete mode 100644 Documentation/.gitattributes diff --git a/Documentation/.gitattributes b/Documentation/.gitattributes deleted file mode 100644 index ddb030137d..0000000000 --- a/Documentation/.gitattributes +++ /dev/null @@ -1 +0,0 @@ -*.txt whitespace -- cgit v1.3 From d40da0bd4b3c9c591fe36d4772d44209fbd70504 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:02 -0500 Subject: Makefile: update reference to technical/racy-git.adoc Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index a9b2de0692..a8012569da 100644 --- a/Makefile +++ b/Makefile @@ -194,7 +194,7 @@ include shared.mak # Linux, kernel 2.6.11 or newer is required for reliable sub-second file times # on file systems with exactly 1 ns or 1 s resolution. If you intend to use Git # on other file systems (e.g. CEPH, CIFS, NTFS, UDF), don't enable USE_NSEC. See -# Documentation/technical/racy-git.txt for details. +# Documentation/technical/racy-git.adoc for details. # # Define USE_ST_TIMESPEC if your "struct stat" uses "st_ctimespec" instead of # "st_ctim" -- cgit v1.3 From c50fbb2dd225e7e82abba4380423ae105089f4d7 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:03 -0500 Subject: README: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 665ce5f5a8..d87bca1b8c 100644 --- a/README.md +++ b/README.md @@ -17,15 +17,15 @@ Please read the file [INSTALL][] for installation instructions. Many Git online resources are accessible from including full documentation and Git related tools. -See [Documentation/gittutorial.txt][] to get started, then see -[Documentation/giteveryday.txt][] for a useful minimum set of commands, and -`Documentation/git-.txt` for documentation of each command. +See [Documentation/gittutorial.adoc][] to get started, then see +[Documentation/giteveryday.adoc][] for a useful minimum set of commands, and +`Documentation/git-.adoc` for documentation of each command. If git has been correctly installed, then the tutorial can also be read with `man gittutorial` or `git help tutorial`, and the documentation of each command with `man git-` or `git help `. -CVS users may also want to read [Documentation/gitcvs-migration.txt][] +CVS users may also want to read [Documentation/gitcvs-migration.adoc][] (`man gitcvs-migration` or `git help cvs-migration` if git is installed). @@ -66,9 +66,9 @@ and the name as (depending on your mood): - "goddamn idiotic truckload of sh*t": when it breaks [INSTALL]: INSTALL -[Documentation/gittutorial.txt]: Documentation/gittutorial.txt -[Documentation/giteveryday.txt]: Documentation/giteveryday.txt -[Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt +[Documentation/gittutorial.adoc]: Documentation/gittutorial.adoc +[Documentation/giteveryday.adoc]: Documentation/giteveryday.adoc +[Documentation/gitcvs-migration.adoc]: Documentation/gitcvs-migration.adoc [Documentation/SubmittingPatches]: Documentation/SubmittingPatches [Documentation/CodingGuidelines]: Documentation/CodingGuidelines [po/README.md]: po/README.md -- cgit v1.3 From 7c78c599bb9b51e5cbdae3e7dc1d723eefcf7c61 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:04 -0500 Subject: CodingGuidelines: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- Documentation/CodingGuidelines | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index ba047ed224..a0e7041c54 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -44,7 +44,7 @@ code are expected to match the style the surrounding code already uses (even if it doesn't match the overall style of existing code). But if you must have a list of rules, here are some language -specific ones. Note that Documentation/ToolsForGit.txt document +specific ones. Note that Documentation/ToolsForGit.adoc document has a collection of tips to help you use some external tools to conform to these guidelines. @@ -755,7 +755,7 @@ Externally Visible Names Writing Documentation: Most (if not all) of the documentation pages are written in the - AsciiDoc format in *.txt files (e.g. Documentation/git.txt), and + AsciiDoc format in *.adoc files (e.g. Documentation/git.adoc), and processed into HTML and manpages (e.g. git.html and git.1 in the same directory). -- cgit v1.3 From 8b4b41aefb87c9b3dbdf40bb65686cb37038cb71 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:05 -0500 Subject: MyFirstContribution: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- Documentation/MyFirstContribution.adoc | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc index e41654c00a..afcf4b46c1 100644 --- a/Documentation/MyFirstContribution.adoc +++ b/Documentation/MyFirstContribution.adoc @@ -21,7 +21,7 @@ This tutorial aims to summarize the following documents, but the reader may find useful additional context: - `Documentation/SubmittingPatches` -- `Documentation/howto/new-command.txt` +- `Documentation/howto/new-command.adoc` [[getting-help]] === Getting Help @@ -331,7 +331,7 @@ function body: apply standard precedence rules. `git_config_get_string_tmp()` will look up a specific key ("user.name") and give you the value. There are a number of single-key lookup functions like this one; you can see them all (and more info -about how to use `git_config()`) in `Documentation/technical/api-config.txt`. +about how to use `git_config()`) in `Documentation/technical/api-config.adoc`. You should see that the name printed matches the one you see when you run: @@ -461,10 +461,10 @@ $ ./bin-wrappers/git help psuh Your new command is undocumented! Let's fix that. -Take a look at `Documentation/git-*.txt`. These are the manpages for the +Take a look at `Documentation/git-*.adoc`. These are the manpages for the subcommands that Git knows about. You can open these up and take a look to get acquainted with the format, but then go ahead and make a new file -`Documentation/git-psuh.txt`. Like with most of the documentation in the Git +`Documentation/git-psuh.adoc`. Like with most of the documentation in the Git project, help pages are written with AsciiDoc (see CodingGuidelines, "Writing Documentation" section). Use the following template to fill out your own manpage: @@ -543,7 +543,7 @@ Try and run `./bin-wrappers/git psuh -h`. Your command should crash at the end. That's because `-h` is a special case which your command should handle by printing usage. -Take a look at `Documentation/technical/api-parse-options.txt`. This is a handy +Take a look at `Documentation/technical/api-parse-options.adoc`. This is a handy tool for pulling out options you need to be able to handle, and it takes a usage string. @@ -1088,14 +1088,14 @@ This gives reviewers a summary of what they're in for when reviewing your topic. The one generated for `psuh` from the sample implementation looks like this: ---- - Documentation/git-psuh.txt | 40 +++++++++++++++++++++ - Makefile | 1 + - builtin.h | 1 + - builtin/psuh.c | 73 ++++++++++++++++++++++++++++++++++++++ - git.c | 1 + - t/t9999-psuh-tutorial.sh | 12 +++++++ + Documentation/git-psuh.adoc | 40 +++++++++++++++++++++ + Makefile | 1 + + builtin.h | 1 + + builtin/psuh.c | 73 ++++++++++++++++++++++++++++++++++++++ + git.c | 1 + + t/t9999-psuh-tutorial.sh | 12 +++++++ 6 files changed, 128 insertions(+) - create mode 100644 Documentation/git-psuh.txt + create mode 100644 Documentation/git-psuh.adoc create mode 100644 builtin/psuh.c create mode 100755 t/t9999-psuh-tutorial.sh ---- -- cgit v1.3 From 5ac2c61b550eb801d3acab1aa68f52379f9ad33b Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:06 -0500 Subject: MyFirstObjectWalk: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- Documentation/MyFirstObjectWalk.adoc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/MyFirstObjectWalk.adoc b/Documentation/MyFirstObjectWalk.adoc index dec8afe5b1..d6e9dfdbbe 100644 --- a/Documentation/MyFirstObjectWalk.adoc +++ b/Documentation/MyFirstObjectWalk.adoc @@ -15,7 +15,7 @@ revision walk is used for operations like `git log`. === Related Reading -- `Documentation/user-manual.txt` under "Hacking Git" contains some coverage of +- `Documentation/user-manual.adoc` under "Hacking Git" contains some coverage of the revision walker in its various incarnations. - `revision.h` - https://eagain.net/articles/git-for-computer-scientists/[Git for Computer Scientists] @@ -112,7 +112,7 @@ $ GIT_TRACE=1 ./bin-wrappers/git walken ---- NOTE: For a more exhaustive overview of the new command process, take a look at -`Documentation/MyFirstContribution.txt`. +`Documentation/MyFirstContribution.adoc`. NOTE: A reference implementation can be found at https://github.com/nasamuffin/git/tree/revwalk. @@ -132,7 +132,7 @@ used to track the allocated size of the list. Per entry, we find: `item` is the object provided upon which to base the object walk. Items in Git -can be blobs, trees, commits, or tags. (See `Documentation/gittutorial-2.txt`.) +can be blobs, trees, commits, or tags. (See `Documentation/gittutorial-2.adoc`.) `name` is the object ID (OID) of the object - a hex string you may be familiar with from using Git to organize your source in the past. Check the tutorial @@ -141,7 +141,7 @@ from. `whence` indicates some information about what to do with the parents of the specified object. We'll explore this flag more later on; take a look at -`Documentation/revisions.txt` to get an idea of what could set the `whence` +`Documentation/revisions.adoc` to get an idea of what could set the `whence` value. `flags` are used to hint the beginning of the revision walk and are the first @@ -153,7 +153,7 @@ can be used during the walk, as well. This one is quite a bit longer, and many fields are only used during the walk by `revision.c` - not configuration options. Most of the configurable flags in -`struct rev_info` have a mirror in `Documentation/rev-list-options.txt`. It's a +`struct rev_info` have a mirror in `Documentation/rev-list-options.adoc`. It's a good idea to take some time and read through that document. == Basic Commit Walk @@ -710,7 +710,7 @@ objects grows along with the Git project. === Adding a Filter There are a handful of filters that we can apply to the object walk laid out in -`Documentation/rev-list-options.txt`. These filters are typically useful for +`Documentation/rev-list-options.adoc`. These filters are typically useful for operations such as creating packfiles or performing a partial clone. They are defined in `list-objects-filter-options.h`. For the purposes of this tutorial we will use the "tree:1" filter, which causes the walk to omit all trees and blobs -- cgit v1.3 From 9100c91cd4c83827b6c3c296e3b2ce89f9e98f52 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:07 -0500 Subject: howto/new-command: update reference to builtin docs Commit ec14d4ecb5 (builtin.h: take over documentation from api-builtin.txt, 2017-08-02) deleted api-builtin.txt and moved the contents into builtin.h. Most of the references were fixed in d85e9448dd (new-command.txt: update reference to builtin docs, 2023-02-04), but one remained. Fix it. Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- Documentation/howto/new-command.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/howto/new-command.adoc b/Documentation/howto/new-command.adoc index 880c51112b..ac73c98be7 100644 --- a/Documentation/howto/new-command.adoc +++ b/Documentation/howto/new-command.adoc @@ -48,7 +48,7 @@ binary); this organization makes it easy for people reading the code to find things. See the CodingGuidelines document for other guidance on what we consider -good practice in C and shell, and api-builtin.txt for the support +good practice in C and shell, and builtin.h for the support functions available to built-in commands written in C. What every extension command needs -- cgit v1.3 From 59d92809088f28b06b0cd102dd166ba8b3144fc7 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:08 -0500 Subject: technical/partial-clone: update reference to rev-list-options.adoc Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- Documentation/technical/partial-clone.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/technical/partial-clone.adoc b/Documentation/technical/partial-clone.adoc index bf5ec5c82d..e513e391ea 100644 --- a/Documentation/technical/partial-clone.adoc +++ b/Documentation/technical/partial-clone.adoc @@ -85,7 +85,7 @@ See "filter" in linkgit:gitprotocol-pack[5]. server to request filtering during packfile construction. + There are various filters available to accommodate different situations. -See "--filter=" in Documentation/rev-list-options.txt. +See "--filter=" in Documentation/rev-list-options.adoc. - On the server pack-objects applies the requested filter-spec as it creates "filtered" packfiles for the client. -- cgit v1.3 From 97350e18e2fc2e753e34df4ee8c1107457aa0a91 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:09 -0500 Subject: doc: *.txt -> *.adoc fixes Update a few more instances of Documentation/*.txt files which have been renamed to *.adoc. Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- Documentation/gitattributes.adoc | 6 +++--- Documentation/technical/api-simple-ipc.adoc | 2 +- Documentation/technical/hash-function-transition.adoc | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/gitattributes.adoc b/Documentation/gitattributes.adoc index 7eaca89972..a22d1ef1e1 100644 --- a/Documentation/gitattributes.adoc +++ b/Documentation/gitattributes.adoc @@ -513,7 +513,7 @@ If the filter command (a string value) is defined via `filter..process` then Git can process all blobs with a single filter invocation for the entire life of a single Git command. This is achieved by using the long-running process protocol -(described in technical/long-running-process-protocol.txt). +(described in Documentation/technical/long-running-process-protocol.adoc). When Git encounters the first file that needs to be cleaned or smudged, it starts the filter and performs the handshake. In the handshake, the @@ -1177,11 +1177,11 @@ integer has a meaningful effect. For example, this line in `.gitattributes` can be used to tell the merge machinery to leave much longer (instead of the usual 7-character-long) -conflict markers when merging the file `Documentation/git-merge.txt` +conflict markers when merging the file `Documentation/git-merge.adoc` results in a conflict. ------------------------ -Documentation/git-merge.txt conflict-marker-size=32 +Documentation/git-merge.adoc conflict-marker-size=32 ------------------------ diff --git a/Documentation/technical/api-simple-ipc.adoc b/Documentation/technical/api-simple-ipc.adoc index c4fb152b23..972178b042 100644 --- a/Documentation/technical/api-simple-ipc.adoc +++ b/Documentation/technical/api-simple-ipc.adoc @@ -36,7 +36,7 @@ Comparison with sub-process model --------------------------------- The Simple-IPC mechanism differs from the existing `sub-process.c` -model (Documentation/technical/long-running-process-protocol.txt) and +model (Documentation/technical/long-running-process-protocol.adoc) and used by applications like Git-LFS. In the LFS-style sub-process model, the helper is started by the foreground process, communication happens via a pair of file descriptors bound to the stdin/stdout of the diff --git a/Documentation/technical/hash-function-transition.adoc b/Documentation/technical/hash-function-transition.adoc index 7102c7c8f5..f047fd80ca 100644 --- a/Documentation/technical/hash-function-transition.adoc +++ b/Documentation/technical/hash-function-transition.adoc @@ -394,7 +394,7 @@ inflated again in step 3, for a total of two inflations. Step 4 is probably necessary for good read-time performance. "git pack-objects" on the server optimizes the pack file for good data -locality (see Documentation/technical/pack-heuristics.txt). +locality (see Documentation/technical/pack-heuristics.adoc). Details of this process are likely to change. It will take some experimenting to get this to perform well. -- cgit v1.3 From d795c65b3a29dca33991c441a9951fb9dd14eead Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:10 -0500 Subject: advice.h: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- advice.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/advice.h b/advice.h index cf2284ec43..d233cfc693 100644 --- a/advice.h +++ b/advice.h @@ -7,7 +7,7 @@ struct string_list; * To add a new advice, you need to: * Define a new advice_type. * Add a new entry to advice_setting array. - * Add the new config variable to Documentation/config/advice.txt. + * Add the new config variable to Documentation/config/advice.adoc. * Call advise_if_enabled to print your advice. */ enum advice_type { -- cgit v1.3 From 08ce333d361890714829897e9f3b9fc9ec06eb4f Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:11 -0500 Subject: apply.c: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- apply.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apply.c b/apply.c index b124678b93..f274a37948 100644 --- a/apply.c +++ b/apply.c @@ -82,7 +82,7 @@ static int parse_whitespace_option(struct apply_state *state, const char *option } /* * Please update $__git_whitespacelist in git-completion.bash, - * Documentation/git-apply.txt, and Documentation/git-am.txt + * Documentation/git-apply.adoc, and Documentation/git-am.adoc * when you add new options. */ return error(_("unrecognized whitespace option '%s'"), option); -- cgit v1.3 From e8015223c74938548dfd8d6099b1ea5eb6ab9231 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:12 -0500 Subject: builtin.h: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- builtin.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/builtin.h b/builtin.h index 89928ccf92..993a583872 100644 --- a/builtin.h +++ b/builtin.h @@ -63,7 +63,7 @@ * * . Add tests to `t/` directory. * - * . Write documentation in `Documentation/git-foo.txt`. + * . Write documentation in `Documentation/git-foo.adoc`. * * . Add an entry for `git-foo` to `command-list.txt`. * -- cgit v1.3 From bbd6174b2501a3523d778dbd479e85119c86840f Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:13 -0500 Subject: config.c: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- config.c | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/config.c b/config.c index 36f76fafe5..dcb5cb5265 100644 --- a/config.c +++ b/config.c @@ -1652,7 +1652,7 @@ static int git_default_core_config(const char *var, const char *value, return 0; } - /* Add other config variables here and to Documentation/config.txt. */ + /* Add other config variables here and to Documentation/config.adoc. */ return platform_core_config(var, value, ctx, cb); } @@ -1663,7 +1663,7 @@ static int git_default_sparse_config(const char *var, const char *value) return 0; } - /* Add other config variables here and to Documentation/config/sparse.txt. */ + /* Add other config variables here and to Documentation/config/sparse.adoc. */ return 0; } @@ -1679,7 +1679,7 @@ static int git_default_i18n_config(const char *var, const char *value) return git_config_string(&git_log_output_encoding, var, value); } - /* Add other config variables here and to Documentation/config.txt. */ + /* Add other config variables here and to Documentation/config.adoc. */ return 0; } @@ -1715,7 +1715,7 @@ static int git_default_branch_config(const char *var, const char *value) return 0; } - /* Add other config variables here and to Documentation/config.txt. */ + /* Add other config variables here and to Documentation/config.adoc. */ return 0; } @@ -1744,7 +1744,7 @@ static int git_default_push_config(const char *var, const char *value) return 0; } - /* Add other config variables here and to Documentation/config.txt. */ + /* Add other config variables here and to Documentation/config.adoc. */ return 0; } @@ -1760,7 +1760,7 @@ static int git_default_mailmap_config(const char *var, const char *value) return git_config_string(&git_mailmap_blob, var, value); } - /* Add other config variables here and to Documentation/config.txt. */ + /* Add other config variables here and to Documentation/config.adoc. */ return 0; } @@ -1773,7 +1773,7 @@ static int git_default_attr_config(const char *var, const char *value) /* * Add other attribute related config variables here and to - * Documentation/config/attr.txt. + * Documentation/config/attr.adoc. */ return 0; } @@ -1831,7 +1831,7 @@ int git_default_config(const char *var, const char *value, if (starts_with(var, "sparse.")) return git_default_sparse_config(var, value); - /* Add other config variables here and to Documentation/config.txt. */ + /* Add other config variables here and to Documentation/config.adoc. */ return 0; } -- cgit v1.3 From 87e0910fb821d125fc06d25a8309d3c668045f57 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:14 -0500 Subject: contrib/long-running-filter: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- contrib/long-running-filter/example.pl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contrib/long-running-filter/example.pl b/contrib/long-running-filter/example.pl index a677569ddd..4b83e4c5e8 100755 --- a/contrib/long-running-filter/example.pl +++ b/contrib/long-running-filter/example.pl @@ -1,7 +1,7 @@ #!/usr/bin/perl # # Example implementation for the Git filter protocol version 2 -# See Documentation/gitattributes.txt, section "Filter Protocol" +# See Documentation/gitattributes.adoc, section "Filter Protocol" # # Please note, this pass-thru filter is a minimal skeleton. No proper # error handling was implemented. -- cgit v1.3 From 5c0375266594f19f3d73969718a5806662cd6d63 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:15 -0500 Subject: diff.h: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- diff.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/diff.h b/diff.h index 0a566f5531..ff0348e4a9 100644 --- a/diff.h +++ b/diff.h @@ -333,7 +333,7 @@ struct diff_options { int xdl_opts; int ignore_driver_algorithm; - /* see Documentation/diff-options.txt */ + /* see Documentation/diff-options.adoc */ char **anchors; size_t anchors_nr, anchors_alloc; -- cgit v1.3 From 3936e95a7f056877425c6faa6994d9f3712a6fb0 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:16 -0500 Subject: diffcore.h: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- diffcore.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/diffcore.h b/diffcore.h index 2feb325031..9c0a0e7aaf 100644 --- a/diffcore.h +++ b/diffcore.h @@ -107,7 +107,7 @@ struct diff_filepair { struct diff_filespec *one; struct diff_filespec *two; unsigned short int score; - char status; /* M C R A D U etc. (see Documentation/diff-format.txt or DIFF_STATUS_* in diff.h) */ + char status; /* M C R A D U etc. (see Documentation/diff-format.adoc or DIFF_STATUS_* in diff.h) */ unsigned broken_pair : 1; unsigned renamed_pair : 1; unsigned is_unmerged : 1; -- cgit v1.3 From c09c29b43046373a0ace268c6de6266b5817dbc3 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:17 -0500 Subject: fsck.h: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- fsck.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fsck.h b/fsck.h index a44c231a5f..a95ae7eb84 100644 --- a/fsck.h +++ b/fsck.h @@ -15,7 +15,7 @@ enum fsck_msg_type { }; /* - * Documentation/fsck-msgids.txt documents these; when + * Documentation/fsck-msgids.adoc documents these; when * modifying this list in any way, make sure to keep the * two in sync. */ -- cgit v1.3 From 02ed88f6a23d142f6e5c7e0b351704654796a6fe Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:18 -0500 Subject: list-objects-filter-options.h: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- list-objects-filter-options.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/list-objects-filter-options.h b/list-objects-filter-options.h index 55fab8563d..7b2108b986 100644 --- a/list-objects-filter-options.h +++ b/list-objects-filter-options.h @@ -82,7 +82,7 @@ void list_objects_filter_init(struct list_objects_filter_options *filter_options * "filter" SP * * The filter keyword will be used by many commands. - * See Documentation/rev-list-options.txt for allowed values for . + * See Documentation/rev-list-options.adoc for allowed values for . * * Capture the given arg as the "filter_spec". This can be forwarded to * subordinate commands when necessary (although it's better to pass it through -- cgit v1.3 From 550fac1d131d764c7c5ec5d69f53290c30855be6 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:19 -0500 Subject: object-name.c: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- object-name.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/object-name.c b/object-name.c index 945d5bdef2..76749fbfe6 100644 --- a/object-name.c +++ b/object-name.c @@ -1273,7 +1273,7 @@ static int peel_onion(struct repository *r, const char *name, int len, } /* - * Documentation/revisions.txt says: + * Documentation/revisions.adoc says: * '', e.g. 'v1.7.4.2-679-g3bee7fb':: * Output from `git describe`; i.e. a closest tag, optionally * followed by a dash and a number of commits, followed by a dash, a -- cgit v1.3 From 458f8b0eab9af7b770a25e9277f70bb4df3c8d90 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:20 -0500 Subject: parse-options.h: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- parse-options.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/parse-options.h b/parse-options.h index fca944d9a9..997ffbee80 100644 --- a/parse-options.h +++ b/parse-options.h @@ -6,7 +6,7 @@ struct repository; /** - * Refer to Documentation/technical/api-parse-options.txt for the API doc. + * Refer to Documentation/technical/api-parse-options.adoc for the API doc. */ enum parse_opt_type { -- cgit v1.3 From dc657d56254d335016c02fb14bb257e37b8cde89 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:21 -0500 Subject: pseudo-merge.h: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- pseudo-merge.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pseudo-merge.h b/pseudo-merge.h index 29df8a32ec..c9fbe9d312 100644 --- a/pseudo-merge.h +++ b/pseudo-merge.h @@ -101,7 +101,7 @@ void select_pseudo_merges(struct bitmap_writer *writer); /* * Represents a serialized view of a file containing pseudo-merge(s) - * (see Documentation/technical/bitmap-format.txt for a specification + * (see Documentation/technical/bitmap-format.adoc for a specification * of the format). */ struct pseudo_merge_map { -- cgit v1.3 From 72d385824a75e1d39b2a4395852dc954907fcc7d Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:22 -0500 Subject: refs.h: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- refs.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/refs.h b/refs.h index 09be47afbe..31c67a71b2 100644 --- a/refs.h +++ b/refs.h @@ -577,7 +577,7 @@ int refs_for_each_reflog(struct ref_store *refs, each_reflog_fn fn, void *cb_dat /* * Return 0 iff refname has the correct format for a refname according - * to the rules described in Documentation/git-check-ref-format.txt. + * to the rules described in Documentation/git-check-ref-format.adoc. * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then * allow a single "*" wildcard character in the refspec. No leading or -- cgit v1.3 From 0543300b594eb1337ce33415997b47594bf29056 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:23 -0500 Subject: setup.c: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- setup.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.c b/setup.c index 7da7aa8984..801bd8c1ee 100644 --- a/setup.c +++ b/setup.c @@ -1822,7 +1822,7 @@ const char *setup_git_directory_gently(int *nongit_ok) * * Regardless of the state of nongit_ok, startup_info->prefix and * the GIT_PREFIX environment variable must always match. For details - * see Documentation/config/alias.txt. + * see Documentation/config/alias.adoc. */ if (nongit_ok && *nongit_ok) startup_info->have_repository = 0; -- cgit v1.3 From 9f04cd7c61d35a9afc81d0625dc914c5221d22ab Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:24 -0500 Subject: simple-ipc.h: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- simple-ipc.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/simple-ipc.h b/simple-ipc.h index 3916eaf70d..701e005cb8 100644 --- a/simple-ipc.h +++ b/simple-ipc.h @@ -2,7 +2,7 @@ #define GIT_SIMPLE_IPC_H /* - * See Documentation/technical/api-simple-ipc.txt + * See Documentation/technical/api-simple-ipc.adoc */ enum ipc_active_state { -- cgit v1.3 From e680c625424e153580e8f2d78ae2ffaa42335221 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:25 -0500 Subject: t/helper/test-rot13-filter.c: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- t/helper/test-rot13-filter.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/t/helper/test-rot13-filter.c b/t/helper/test-rot13-filter.c index ff407b575c..722b1cbe77 100644 --- a/t/helper/test-rot13-filter.c +++ b/t/helper/test-rot13-filter.c @@ -1,6 +1,6 @@ /* * Example implementation for the Git filter protocol version 2 - * See Documentation/gitattributes.txt, section "Filter Protocol" + * See Documentation/gitattributes.adoc, section "Filter Protocol" * * Usage: test-tool rot13-filter [--always-delay] --log= * -- cgit v1.3 From 8ea7d41f171fd52d3c920d40fdb390fd969a3270 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:26 -0500 Subject: t6012: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- t/t6012-rev-list-simplify.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/t/t6012-rev-list-simplify.sh b/t/t6012-rev-list-simplify.sh index de1e87f162..4cecb6224c 100755 --- a/t/t6012-rev-list-simplify.sh +++ b/t/t6012-rev-list-simplify.sh @@ -177,7 +177,7 @@ test_expect_success '--full-diff is not affected by --parents' ' # \ / /\ / # `---X--' `---Y--' # -# This example is explained in Documentation/rev-list-options.txt +# This example is explained in Documentation/rev-list-options.adoc test_expect_success 'setup rebuild repo' ' rm -rf .git * && -- cgit v1.3 From 366074dc1843764c199c5b7a6354c58b8ac0b5c2 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:27 -0500 Subject: t6434: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- t/t6434-merge-recursive-rename-options.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/t/t6434-merge-recursive-rename-options.sh b/t/t6434-merge-recursive-rename-options.sh index a11707835b..6e913c30a1 100755 --- a/t/t6434-merge-recursive-rename-options.sh +++ b/t/t6434-merge-recursive-rename-options.sh @@ -22,7 +22,7 @@ R075 2-old 2-new R100 3-old 3-new Actual similarity indices are parsed from diff output. We rely on the fact that -they are rounded down (see, e.g., Documentation/diff-generate-patch.txt, which +they are rounded down (see, e.g., Documentation/diff-generate-patch.adoc, which mentions this in a different context). ' -- cgit v1.3 From 508cf7f5d8907a281602a54551abcc58a16d0493 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:28 -0500 Subject: trace2.h: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- trace2.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/trace2.h b/trace2.h index 901f39253a..e4f23784e4 100644 --- a/trace2.h +++ b/trace2.h @@ -31,7 +31,7 @@ * * For more info about: trace2 targets, conventions for public functions and * macros, trace2 target formats and examples on trace2 API usage refer to - * Documentation/technical/api-trace2.txt + * Documentation/technical/api-trace2.adoc * */ -- cgit v1.3 From 15db9a895d36a29eac2061ec31eba5e9628b4a5b Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:29 -0500 Subject: trace2/tr2_sysenv.c: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- trace2/tr2_sysenv.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/trace2/tr2_sysenv.c b/trace2/tr2_sysenv.c index 01379c5cad..4abc218514 100644 --- a/trace2/tr2_sysenv.c +++ b/trace2/tr2_sysenv.c @@ -7,7 +7,7 @@ /* * Each entry represents a trace2 setting. - * See Documentation/technical/api-trace2.txt + * See Documentation/technical/api-trace2.adoc */ struct tr2_sysenv_entry { const char *env_var_name; -- cgit v1.3 From ee00ef41f269bda33370acbacb41f5ca9a200a9b Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:30 -0500 Subject: transport.h: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- transport.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/transport.h b/transport.h index 44100fa9b7..892f19454a 100644 --- a/transport.h +++ b/transport.h @@ -168,7 +168,7 @@ struct transport *transport_get(struct remote *, const char *); * Check whether a transport is allowed by the environment. * * Type should generally be the URL scheme, as described in - * Documentation/git.txt + * Documentation/git.adoc * * from_user specifies if the transport was given by the user. If unknown pass * a -1 to read from the environment to determine if the transport was given by -- cgit v1.3 From d6b67cefb5c27d1479d41a8fae1a03b8aece82f6 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:31 -0500 Subject: unpack-trees.c: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- unpack-trees.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/unpack-trees.c b/unpack-trees.c index 334cb84f65..cf5b73c84b 100644 --- a/unpack-trees.c +++ b/unpack-trees.c @@ -2904,7 +2904,7 @@ int threeway_merge(const struct cache_entry * const *stages, * The rule is to "carry forward" what is in the index without losing * information across a "fast-forward", favoring a successful merge * over a merge failure when it makes sense. For details of the - * "carry forward" rule, please see . + * "carry forward" rule, please see . * */ int twoway_merge(const struct cache_entry * const *src, -- cgit v1.3 From 61cd812130bda9c8996c90283501ee00c029c7a4 Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 3 Mar 2025 15:44:32 -0500 Subject: xdiff: *.txt -> *.adoc fixes Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano --- xdiff/xdiff.h | 2 +- xdiff/xpatience.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/xdiff/xdiff.h b/xdiff/xdiff.h index bb56b23f34..2cecde5afe 100644 --- a/xdiff/xdiff.h +++ b/xdiff/xdiff.h @@ -85,7 +85,7 @@ typedef struct s_xpparam { regex_t **ignore_regex; size_t ignore_regex_nr; - /* See Documentation/diff-options.txt. */ + /* See Documentation/diff-options.adoc. */ char **anchors; size_t anchors_nr; } xpparam_t; diff --git a/xdiff/xpatience.c b/xdiff/xpatience.c index 82f663004e..77dc411d19 100644 --- a/xdiff/xpatience.c +++ b/xdiff/xpatience.c @@ -64,7 +64,7 @@ struct hashmap { /* * If 1, this entry can serve as an anchor. See - * Documentation/diff-options.txt for more information. + * Documentation/diff-options.adoc for more information. */ unsigned anchor : 1; } *entries, *first, *last; -- cgit v1.3