Skip to content

Commit

Permalink
doc: use 'object database' not ODB or abbreviation
Browse files Browse the repository at this point in the history
The abbreviation 'ODB' is used in the technical documentation
sections for commit-graph and parallel-checkout, along with an
'odb' option in `git-pack-redundant`, without expansion.

Use 'object database' in full, in those entries. The text has not
been reflowed to keep the changes minimal.

While in the glossary for `object` terms, add the common`oid`
abbreviation to its entry.

Signed-off-by: Philip Oakley <philipoakley@iee.email>
Signed-off-by: Taylor Blau <me@ttaylorr.com>
  • Loading branch information
PhilipOakley authored and ttaylorr committed Oct 30, 2022
1 parent 776ba91 commit fa8e8d5
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Documentation/git-pack-redundant.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ OPTIONS

--alt-odb::
Don't require objects present in packs from alternate object
directories to be present in local packs.
database (odb) directories to be present in local packs.

--verbose::
Outputs some statistics to stderr. Has a small performance penalty.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/glossary-content.txt
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ This commit is referred to as a "merge commit", or sometimes just a
identified by its <<def_object_name,object name>>. The objects usually
live in `$GIT_DIR/objects/`.

[[def_object_identifier]]object identifier::
[[def_object_identifier]]object identifier (oid)::
Synonym for <<def_object_name,object name>>.

[[def_object_name]]object name::
Expand Down
2 changes: 1 addition & 1 deletion Documentation/technical/commit-graph.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ There are two main costs here:

The commit-graph file is a supplemental data structure that accelerates
commit graph walks. If a user downgrades or disables the 'core.commitGraph'
config setting, then the existing ODB is sufficient. The file is stored
config setting, then the existing object database is sufficient. The file is stored
as "commit-graph" either in the .git/objects/info directory or in the info
directory of an alternate.

Expand Down
2 changes: 1 addition & 1 deletion Documentation/technical/parallel-checkout.txt
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Rejected Multi-Threaded Solution

The most "straightforward" implementation would be to spread the set of
to-be-updated cache entries across multiple threads. But due to the
thread-unsafe functions in the ODB code, we would have to use locks to
thread-unsafe functions in the object database code, we would have to use locks to
coordinate the parallel operation. An early prototype of this solution
showed that the multi-threaded checkout would bring performance
improvements over the sequential code, but there was still too much lock
Expand Down

0 comments on commit fa8e8d5

Please sign in to comment.