Subject: [PATCH v3 0/4] Documentation/git-bundle.txt: promote --all for full backup

From: [email-masked]
Date: Thu, 7 Nov 2024 12:57:32 +0100

From: Kristoffer Haugsbakk <[email-masked]>

The documentation for git-bundle(1) now prominently covers `--all`, the
option from git-rev-list(1) that can be used to package all refs.  A
"Discussion" section has also been added to address the naive backup
strategy of copying a Git repository manually with cp(1) or some other
non-Git tool.

---

The part above was for the-topic-summary.

I was prompted by SO questions like this one:

    https://stackoverflow.com/questions/5578270/fully-backup-a-git-repo

I then compared VonC’s answer to the man page.

Cheers

§ Changes in v3

After some feedback from Junio I’ve added a disclaimer about what this
“full backup” does not cover, like e.g. repo config.  And since this
requires some introduction and overall space (paragraphs), I’ve moved it
into the Examples section.  To structure this now two-example section it
now starts with a list of what examples are coming up.  The second
example is marked by “For the next example”.

I’ve also noted what the “full backup” does not cover in the Discussion
section.

The details are noted on the patches.

Kristoffer Haugsbakk (4):
  Documentation/git-bundle.txt: mention full backup example
  Documentation/git-bundle.txt: remove old `--all` example
  Documentation/git-bundle.txt: mention --all in spec. refs
  Documentation/git-bundle.txt: discuss naïve backups

 Documentation/git-bundle.txt | 52 +++++++++++++++++++++++++++++-------
 1 file changed, 43 insertions(+), 9 deletions(-)

Interdiff against v2:
diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index 7bffd2e4a05..ad9ab3247f5 100644
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -23,8 +23,9 @@ the "offline" transfer of Git objects without an active "server"
 sitting on the other side of the network connection.
 
 They can be used to create both incremental and full backups of a
-repository (`git bundle create <file> --all`), and to relay the state of
-the references in one repository to another.
+repository (see the "full backup" example in "EXAMPLES"), and to relay
+the state of the references in one repository to another (see the second
+example).
 
 Git commands that fetch or otherwise "read" via protocols such as
 `ssh://` and `https://` can also operate on bundle files. It is
@@ -34,8 +35,6 @@ contained within it with linkgit:git-ls-remote[1]. There's no
 corresponding "write" support, i.e.a 'git push' into a bundle is not
 supported.
 
-See the "EXAMPLES" section below for examples of how to use bundles.
-
 BUNDLE FORMAT
 -------------
 
@@ -214,8 +213,27 @@ bundle.
 EXAMPLES
 --------
 
-Assume you want to transfer the history from a repository R1 on machine A
-to another repository R2 on machine B.
+We'll discuss two cases:
+
+1. Taking a full backup of a repository
+2. Transfer the history of a repository to another machine when the two
+   machines have no direct connection
+
+First let's consider a full backup of the repository.  The following
+command will take a full backup of the repository in the sense that all
+refs are included in the bundle (except `refs/stash`, i.e. the stash):
+
+----------------
+$ git bundle create <file> --all
+----------------
+
+But note again that this is only for the refs, i.e. you will only
+include refs and commits reachable from those refs.  You will not
+include other local state, such as the contents of the index, working
+tree, per-repository configuration, hooks, etc.
+
+For the next example, assume you want to transfer the history from a
+repository R1 on machine A to another repository R2 on machine B.
 For whatever reason, direct connection between A and B is not allowed,
 but we can move data from A to B via some mechanism (CD, email, etc.).
 We want to update R2 with development made on the branch master in R1.
@@ -323,12 +341,16 @@ DISCUSSION
 ----------
 
 A naive way to make a full backup of a repository is to use something to
-the effect of `cp -a <repo> <destination>`.  This is discouraged since
+the effect of `cp -r <repo> <destination>`.  This is discouraged since
 the repository could be written to during the copy operation.  In turn
 some files at `<destination>` could be corrupted.
 
 This is why it is recommended to use Git tooling for making repository
 backups, either with this command or with e.g. linkgit:git-clone[1].
+But keep in mind that these tools will not help you backup state other
+than refs and commits.  In other words they will not help you backup
+contents of the index, working tree, per-repository configuration,
+hooks, etc.
 
 See also linkgit:gitfaq[7], section "TRANSFERS" for a discussion of the
 problems associated with file syncing across systems.
Range-diff against v2:
1:  e9be866f33d ! 1:  b222c6787a7 Documentation/git-bundle.txt: mention full backup example
    @@ Metadata
      ## Commit message ##
         Documentation/git-bundle.txt: mention full backup example
     
    -    Tell the user how to make a full backup of the repository right at the
    -    start of the doc.
    +    Provide an example about how to make a “full backup” with caveats about
    +    what that means in this case.
     
         This is a requested use-case.[1]  But the doc is a bit unassuming
         about it:
     
    -      “ If you want to match `git clone --mirror`, which would include your
    +        If you want to match `git clone --mirror`, which would include your
             refs such as `refs/remotes/*`, use `--all`.
     
         The user cannot be expected to formulate “I want a full backup” as “I
    @@ Commit message
             • https://stackoverflow.com/questions/5578270/fully-backup-a-git-repo
             • https://stackoverflow.com/questions/11792671/how-to-git-bundle-a-complete-repo
     
    +    Helped-by: Junio C Hamano <[email-masked]>
         Signed-off-by: Kristoffer Haugsbakk <[email-masked]>

      ## Notes (series) ##
    +    v3:
    +    • Elaborate on “full backups” in Examples instead
    +    • Just point to the section in the second paragraph where everything is
    +      elaborated
    +    • Incorporate some of Junio’s suggestions:
    +      • Mention what the “full backup” here does not include
    +
    +        Link: https://lore.kernel.org/git/[email-masked]/
    +        Link: https://lore.kernel.org/git/[email-masked]/#t
    +    • Remove the final paragraph pointing to Examples now that we mention it
    +      in the second paragraph
         v2:
         • Mention as a parenthetical on an existing paragraph (don’t create a
           new sentence and paragraph)
    @@ Notes (series)
     
           Link (both): https://lore.kernel.org/git/[email-masked]/
     
    +
    + ## Notes (meta-trailers) ##
    +    Helped-by: Junio C Hamano <[email-masked]>
    +        Link: https://lore.kernel.org/git/[email-masked]/
    +
      ## Documentation/git-bundle.txt ##
     @@ Documentation/git-bundle.txt: the "offline" transfer of Git objects without an active "server"
      sitting on the other side of the network connection.
    @@ Documentation/git-bundle.txt: the "offline" transfer of Git objects without an a
      They can be used to create both incremental and full backups of a
     -repository, and to relay the state of the references in one repository
     -to another.
    -+repository (`git bundle create <file> --all`), and to relay the state of
    -+the references in one repository to another.
    ++repository (see the "full backup" example in "EXAMPLES"), and to relay
    ++the state of the references in one repository to another (see the second
    ++example).
      
      Git commands that fetch or otherwise "read" via protocols such as
      `ssh://` and `https://` can also operate on bundle files. It is
    -@@ Documentation/git-bundle.txt: It is okay to err on the side of caution, causing the bundle file
    - to contain objects already in the destination, as these are ignored
    - when unpacking at the destination.
    +@@ Documentation/git-bundle.txt: contained within it with linkgit:git-ls-remote[1]. There's no
    + corresponding "write" support, i.e.a 'git push' into a bundle is not
    + supported.
    + 
    +-See the "EXAMPLES" section below for examples of how to use bundles.
    +-
    + BUNDLE FORMAT
    + -------------
    + 
    +@@ Documentation/git-bundle.txt: bundle.
    + EXAMPLES
    + --------
      
    --If you want to match `git clone --mirror`, which would include your
    --refs such as `refs/remotes/*`, use `--all`.
    - If you want to provide the same set of refs that a clone directly
    - from the source repository would get, use `--branches --tags` for
    - the `<git-rev-list-args>`.
    +-Assume you want to transfer the history from a repository R1 on machine A
    +-to another repository R2 on machine B.
    ++We'll discuss two cases:
    ++
    ++1. Taking a full backup of a repository
    ++2. Transfer the history of a repository to another machine when the two
    ++   machines have no direct connection
    ++
    ++First let's consider a full backup of the repository.  The following
    ++command will take a full backup of the repository in the sense that all
    ++refs are included in the bundle (except `refs/stash`, i.e. the stash):
    ++
    ++----------------
    ++$ git bundle create <file> --all
    ++----------------
    ++
    ++But note again that this is only for the refs, i.e. you will only
    ++include refs and commits reachable from those refs.  You will not
    ++include other local state, such as the contents of the index, working
    ++tree, per-repository configuration, hooks, etc.
    ++
    ++For the next example, assume you want to transfer the history from a
    ++repository R1 on machine A to another repository R2 on machine B.
    + For whatever reason, direct connection between A and B is not allowed,
    + but we can move data from A to B via some mechanism (CD, email, etc.).
    + We want to update R2 with development made on the branch master in R1.
-:  ----------- > 2:  f0dbe356ca6 Documentation/git-bundle.txt: remove old `--all` example
2:  f18f8ca453d = 3:  8336b0f451e Documentation/git-bundle.txt: mention --all in spec. refs
3:  c50f9d405f9 ! 4:  0ab05a4cf09 Documentation/git-bundle.txt: discuss naïve backups
    @@ Commit message

      ## Notes (series) ##
    +    v3:
    +    • Use `cp -r` instead of `cp -a` since the former is more widely
    +      supported (even though it is just an example)
    +    • Mention what this “full backup” does not cover here as well (see first
    +      patch)
         v2:
         • Fix gitfaq(7) link
     
    @@ Documentation/git-bundle.txt: You can also see what references it offers:
     +----------
     +
     +A naive way to make a full backup of a repository is to use something to
    -+the effect of `cp -a <repo> <destination>`.  This is discouraged since
    ++the effect of `cp -r <repo> <destination>`.  This is discouraged since
     +the repository could be written to during the copy operation.  In turn
     +some files at `<destination>` could be corrupted.
     +
     +This is why it is recommended to use Git tooling for making repository
     +backups, either with this command or with e.g. linkgit:git-clone[1].
    ++But keep in mind that these tools will not help you backup state other
    ++than refs and commits.  In other words they will not help you backup
    ++contents of the index, working tree, per-repository configuration,
    ++hooks, etc.
     +
     +See also linkgit:gitfaq[7], section "TRANSFERS" for a discussion of the
     +problems associated with file syncing across systems.

base-commit: 34b6ce9b30747131b6e781ff718a45328aa887d0
-- 
2.46.1.641.g54e7913fcb6