| Message ID | pull.1282.git.1657385781.gitgitgadget@gmail.com (mailing list archive) |
|---|---|
| Headers | show |
| Series | Add some Glossary terms, and extra renormalize information. | expand |
"Philip Oakley via GitGitGadget" <gitgitgadget@gmail.com> writes: > This short series looks to add the basics of the reachability bitmap and > commit graph phrases to the glossary of terms. While these techniques are > well known to their developers, for some, they are just magic phrases. > > The first patch [1/4] is to show OBD as an abbreviation to avoid a UNA [0] Avoiding unnecessary TLA is even better than avoiding. As I didn't see in the other three patches that we need to use the OBD acronym, perhaps we can omit this step? > Patch [2/4] provides a basic statement for the Commit-Graph's purpose. > > Patch [3/4] provides a similar statement for the reachability bitmaps. > > These two patches maybe misses out on some linking information as to the > benefits these have and the basics of their heuristic. > > Patch [4/4] follows up on a bug report about the lack of idempotence for the > `--renormalise' command. See commit message for details. > > [0] UNA Un-Named Abbreviation. > > Signed-off-by: Philip Oakley philipoakley@iee.email > > Philip Oakley (4): > glossary: add Object DataBase (ODB) abbreviation > glossary: add commit graph description > glossary: add reachability bitmap description > doc add: renormalize is not idempotent for CRCRLF > > Documentation/git-add.txt | 3 ++- > Documentation/glossary-content.txt | 15 ++++++++++++++- > 2 files changed, 16 insertions(+), 2 deletions(-) > > > base-commit: 30cc8d0f147546d4dd77bf497f4dec51e7265bd8 > Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1282%2FPhilipOakley%2FGlossary_terms-v1 > Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1282/PhilipOakley/Glossary_terms-v1 > Pull-Request: https://github.com/gitgitgadget/git/pull/1282
Hi Junio, On 09/07/2022 22:34, Junio C Hamano wrote: >> The first patch [1/4] is to show OBD as an abbreviation to avoid a UNA [0] > Avoiding unnecessary TLA is even better than avoiding. As I didn't > see in the other three patches that we need to use the OBD acronym, > perhaps we can omit this step? > This came from seeing `ODB` in a couple of tech docs (commit-graph and parallel-checkout) and an 'odb' option in pack-redundant, which I should have noted in the commit message. I'll update the commit message to clarify that we are using that TLA, though we aren't always consistent in our distinctions between concepts and implementation in many places (e.g. Object Store vs Repository; Staging area..; etc.) TLAs, UNAs, etc. have been a bug-bear of mine from doing large engineering collaborations. -- Philip (for completeness;-) ODB Object Data Base. TLA Three Letter Abbreviation. UNA Un-Named Abbreviation.
This short series looks to add the basics of the reachability bitmap and commit graph phrases to the glossary of terms. While these techniques are well known to their developers, for some, they are just magic phrases. The first patch [1/4] is to show OBD as an abbreviation to avoid a UNA [0] Patch [2/4] provides a basic statement for the Commit-Graph's purpose. Patch [3/4] provides a similar statement for the reachability bitmaps. These two patches maybe misses out on some linking information as to the benefits these have and the basics of their heuristic. Patch [4/4] follows up on a bug report about the lack of idempotence for the `--renormalise' command. See commit message for details. [0] UNA Un-Named Abbreviation. Signed-off-by: Philip Oakley philipoakley@iee.email Philip Oakley (4): glossary: add Object DataBase (ODB) abbreviation glossary: add commit graph description glossary: add reachability bitmap description doc add: renormalize is not idempotent for CRCRLF Documentation/git-add.txt | 3 ++- Documentation/glossary-content.txt | 15 ++++++++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) base-commit: 30cc8d0f147546d4dd77bf497f4dec51e7265bd8 Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1282%2FPhilipOakley%2FGlossary_terms-v1 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1282/PhilipOakley/Glossary_terms-v1 Pull-Request: https://github.com/gitgitgadget/git/pull/1282