It would be useful to list the known tools that suffer from this problem an=
d their version numbers=2E And issues in their issue trackers requesting su=
pport for the new thing=2E So that this instruction can be removed once it =
is no longer needed=2E

21=2E joulukuuta 2024 23=2E44=2E07 GMT+02:00 Hong Xu pagure@pagure=2Eio =
kirjoitti:

xuhdev opened a new pull-request against the project: package-maintainer= -docs that you are following:
Document that git index version must be <=3D 2

To reply, visit the link below or just reply to this email
https://pagure=2Eio/fedora-docs/package-maintainer-docs/pull-request/173

It would be useful to list the known tools that suffer from this problem an=
d their version numbers=2E And issues in their issue trackers requesting su=
pport for the new thing=2E So that this instruction can be removed once it =
is no longer needed=2E

I added an example that I know. I'm not aware of any related issue, nor could I find one.

Thank you. I have two more requests:

This repository uses semantic linebreaks, so please apply linebreaks on full stops, and as needed additionally on commas or other semantically meaningful places.

And, I would like to have a sentence, or part of one, somewhere indicating that index version > 2 is a non-default configuration. Perhaps like "only work with git repositories with index version <= 2. While version 2 is the default, custom Git configuration may result in later versions being used." This is just to put this issue into perspective, otherwise somebody doing the normal thing of using default configuration may think they should to run the git config --global command. I would rather not request uses to manually apply custom configurations which may bite them later on, especially because git config --global's effect is not restricted to dist-git repositories only.

Done. I reworded your suggestion on warning about Git index version 2.

Thank you, I merged this.

I also created a pull request to rpkg, so that in the future, fedpkg clone would set the index version of cloned dist-git repositories to 2 regardless of other possible Git configuration.

The policy for this repository is to grant commit access to everybody with a merged pull request, so I have added you to group package-maintainer-docs. Going forward, you can self-merge trivial fixes. Pull requests are preferred for anything substantial, so others have a way to express their views.

Thanks! Will sure help continue improving the doc.

Now that this change has been deployed, I noticed some formatting that was wrong. Unfortunately, Antora has its own formatting rules that do not match Markdown, which is what most people consider the standard nowadays.

I pushed the fixes in fedcef7adff.