All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
	"Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>
Subject: [PATCH 70/78] config.txt: move transfer.* to a separate file
Date: Sat, 27 Oct 2018 08:23:43 +0200	[thread overview]
Message-ID: <20181027062351.30446-71-pclouds@gmail.com> (raw)
In-Reply-To: <20181027062351.30446-1-pclouds@gmail.com>

Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
---
 Documentation/config.txt          | 72 +------------------------------
 Documentation/config/transfer.txt | 71 ++++++++++++++++++++++++++++++
 2 files changed, 72 insertions(+), 71 deletions(-)
 create mode 100644 Documentation/config/transfer.txt

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 1db9c58e8d..07100e236e 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -421,77 +421,7 @@ include::config/submodule.txt[]
 
 include::config/tag.txt[]
 
-transfer.fsckObjects::
-	When `fetch.fsckObjects` or `receive.fsckObjects` are
-	not set, the value of this variable is used instead.
-	Defaults to false.
-+
-When set, the fetch or receive will abort in the case of a malformed
-object or a link to a nonexistent object. In addition, various other
-issues are checked for, including legacy issues (see `fsck.<msg-id>`),
-and potential security issues like the existence of a `.GIT` directory
-or a malicious `.gitmodules` file (see the release notes for v2.2.1
-and v2.17.1 for details). Other sanity and security checks may be
-added in future releases.
-+
-On the receiving side, failing fsckObjects will make those objects
-unreachable, see "QUARANTINE ENVIRONMENT" in
-linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
-instead be left unreferenced in the repository.
-+
-Due to the non-quarantine nature of the `fetch.fsckObjects`
-implementation it can not be relied upon to leave the object store
-clean like `receive.fsckObjects` can.
-+
-As objects are unpacked they're written to the object store, so there
-can be cases where malicious objects get introduced even though the
-"fetch" failed, only to have a subsequent "fetch" succeed because only
-new incoming objects are checked, not those that have already been
-written to the object store. That difference in behavior should not be
-relied upon. In the future, such objects may be quarantined for
-"fetch" as well.
-+
-For now, the paranoid need to find some way to emulate the quarantine
-environment if they'd like the same protection as "push". E.g. in the
-case of an internal mirror do the mirroring in two steps, one to fetch
-the untrusted objects, and then do a second "push" (which will use the
-quarantine) to another internal repo, and have internal clients
-consume this pushed-to repository, or embargo internal fetches and
-only allow them once a full "fsck" has run (and no new fetches have
-happened in the meantime).
-
-transfer.hideRefs::
-	String(s) `receive-pack` and `upload-pack` use to decide which
-	refs to omit from their initial advertisements.  Use more than
-	one definition to specify multiple prefix strings. A ref that is
-	under the hierarchies listed in the value of this variable is
-	excluded, and is hidden when responding to `git push` or `git
-	fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
-	program-specific versions of this config.
-+
-You may also include a `!` in front of the ref name to negate the entry,
-explicitly exposing it, even if an earlier entry marked it as hidden.
-If you have multiple hideRefs values, later entries override earlier ones
-(and entries in more-specific config files override less-specific ones).
-+
-If a namespace is in use, the namespace prefix is stripped from each
-reference before it is matched against `transfer.hiderefs` patterns.
-For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
-the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
-is omitted from the advertisements but `refs/heads/master` and
-`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
-"have" lines. In order to match refs before stripping, add a `^` in front of
-the ref name. If you combine `!` and `^`, `!` must be specified first.
-+
-Even if you hide refs, a client may still be able to steal the target
-objects via the techniques described in the "SECURITY" section of the
-linkgit:gitnamespaces[7] man page; it's best to keep private data in a
-separate repository.
-
-transfer.unpackLimit::
-	When `fetch.unpackLimit` or `receive.unpackLimit` are
-	not set, the value of this variable is used instead.
-	The default value is 100.
+include::config/transfer.txt[]
 
 uploadarchive.allowUnreachable::
 	If true, allow clients to use `git archive --remote` to request
diff --git a/Documentation/config/transfer.txt b/Documentation/config/transfer.txt
new file mode 100644
index 0000000000..4a5dfe2fc1
--- /dev/null
+++ b/Documentation/config/transfer.txt
@@ -0,0 +1,71 @@
+transfer.fsckObjects::
+	When `fetch.fsckObjects` or `receive.fsckObjects` are
+	not set, the value of this variable is used instead.
+	Defaults to false.
++
+When set, the fetch or receive will abort in the case of a malformed
+object or a link to a nonexistent object. In addition, various other
+issues are checked for, including legacy issues (see `fsck.<msg-id>`),
+and potential security issues like the existence of a `.GIT` directory
+or a malicious `.gitmodules` file (see the release notes for v2.2.1
+and v2.17.1 for details). Other sanity and security checks may be
+added in future releases.
++
+On the receiving side, failing fsckObjects will make those objects
+unreachable, see "QUARANTINE ENVIRONMENT" in
+linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
+instead be left unreferenced in the repository.
++
+Due to the non-quarantine nature of the `fetch.fsckObjects`
+implementation it can not be relied upon to leave the object store
+clean like `receive.fsckObjects` can.
++
+As objects are unpacked they're written to the object store, so there
+can be cases where malicious objects get introduced even though the
+"fetch" failed, only to have a subsequent "fetch" succeed because only
+new incoming objects are checked, not those that have already been
+written to the object store. That difference in behavior should not be
+relied upon. In the future, such objects may be quarantined for
+"fetch" as well.
++
+For now, the paranoid need to find some way to emulate the quarantine
+environment if they'd like the same protection as "push". E.g. in the
+case of an internal mirror do the mirroring in two steps, one to fetch
+the untrusted objects, and then do a second "push" (which will use the
+quarantine) to another internal repo, and have internal clients
+consume this pushed-to repository, or embargo internal fetches and
+only allow them once a full "fsck" has run (and no new fetches have
+happened in the meantime).
+
+transfer.hideRefs::
+	String(s) `receive-pack` and `upload-pack` use to decide which
+	refs to omit from their initial advertisements.  Use more than
+	one definition to specify multiple prefix strings. A ref that is
+	under the hierarchies listed in the value of this variable is
+	excluded, and is hidden when responding to `git push` or `git
+	fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
+	program-specific versions of this config.
++
+You may also include a `!` in front of the ref name to negate the entry,
+explicitly exposing it, even if an earlier entry marked it as hidden.
+If you have multiple hideRefs values, later entries override earlier ones
+(and entries in more-specific config files override less-specific ones).
++
+If a namespace is in use, the namespace prefix is stripped from each
+reference before it is matched against `transfer.hiderefs` patterns.
+For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
+the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
+is omitted from the advertisements but `refs/heads/master` and
+`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
+"have" lines. In order to match refs before stripping, add a `^` in front of
+the ref name. If you combine `!` and `^`, `!` must be specified first.
++
+Even if you hide refs, a client may still be able to steal the target
+objects via the techniques described in the "SECURITY" section of the
+linkgit:gitnamespaces[7] man page; it's best to keep private data in a
+separate repository.
+
+transfer.unpackLimit::
+	When `fetch.unpackLimit` or `receive.unpackLimit` are
+	not set, the value of this variable is used instead.
+	The default value is 100.
-- 
2.19.1.647.g708186aaf9


  parent reply	other threads:[~2018-10-27  6:25 UTC|newest]

Thread overview: 80+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-10-27  6:22 [PATCH 00/78] nd/config-split reroll Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 01/78] Update makefile in preparation for Documentation/config/*.txt Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 02/78] config.txt: move advice.* to a separate file Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 03/78] config.txt: move core.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 04/78] config.txt: move add.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 05/78] config.txt: move alias.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 06/78] config.txt: move am.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 07/78] config.txt: move apply.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 08/78] config.txt: move blame.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 09/78] config.txt: move branch.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 10/78] config.txt: move browser.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 11/78] config.txt: move checkout.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 12/78] config.txt: move clean.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 13/78] config.txt: move color.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 14/78] config.txt: move column.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 15/78] config.txt: move commit.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 16/78] config.txt: move credential.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 17/78] config.txt: move completion.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 18/78] config.txt: move diff-config.txt to config/ Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 19/78] config.txt: move difftool.* to a separate file Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 20/78] config.txt: move fastimport.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 21/78] config.txt: move fetch-config.txt to config/ Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 22/78] config.txt: move filter.* to a separate file Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 23/78] config.txt: move format-config.txt to config/ Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 24/78] config.txt: move fmt-merge-msg-config.txt " Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 25/78] config.txt: move fsck.* to a separate file Nguyễn Thái Ngọc Duy
2018-10-27  6:22 ` [PATCH 26/78] config.txt: move gc.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 27/78] config.txt: move gitcvs-config.txt to config/ Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 28/78] config.txt: move gitweb.* to a separate file Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 29/78] config.txt: move grep.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 30/78] config.txt: move gpg.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 31/78] config.txt: move gui-config.txt to config/ Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 32/78] config.txt: move guitool.* to a separate file Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 33/78] config.txt: move help.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 34/78] config.txt: move ssh.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 35/78] config.txt: move http.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 36/78] config.txt: move i18n.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 37/78] git-imap-send.txt: move imap.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 38/78] config.txt: move index.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 39/78] config.txt: move init.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 40/78] config.txt: move instaweb.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 41/78] config.txt: move interactive.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 42/78] config.txt: move log.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 43/78] config.txt: move mailinfo.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 44/78] config.txt: move mailmap.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 45/78] config.txt: move man.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 46/78] config.txt: move merge-config.txt to config/ Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 47/78] config.txt: move mergetool.* to a separate file Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 48/78] config.txt: move notes.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 49/78] config.txt: move pack.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 50/78] config.txt: move pager.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 51/78] config.txt: move pretty.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 52/78] config.txt: move protocol.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 53/78] config.txt: move pull-config.txt to config/ Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 54/78] config.txt: move push-config.txt " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 55/78] config.txt: move rebase-config.txt " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 56/78] config.txt: move receive-config.txt " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 57/78] config.txt: move remote.* to a separate file Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 58/78] config.txt: move remotes.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 59/78] config.txt: move repack.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 60/78] config.txt: move rerere.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 61/78] config.txt: move reset.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 62/78] config.txt: move sendemail-config.txt to config/ Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 63/78] config.txt: move sequencer.* to a separate file Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 64/78] config.txt: move showBranch.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 65/78] config.txt: move splitIndex.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 66/78] config.txt: move status.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 67/78] config.txt: move stash.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 68/78] config.txt: move submodule.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 69/78] config.txt: move tag.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` Nguyễn Thái Ngọc Duy [this message]
2018-10-27  6:23 ` [PATCH 71/78] config.txt: move uploadarchive.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 72/78] config.txt: move uploadpack.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 73/78] config.txt: move url.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 74/78] config.txt: move user.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 75/78] config.txt: move versionsort.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 76/78] config.txt: move web.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 77/78] config.txt: move worktree.* " Nguyễn Thái Ngọc Duy
2018-10-27  6:23 ` [PATCH 78/78] config.txt: remove config/dummy.txt Nguyễn Thái Ngọc Duy
2018-10-29  1:28 ` [PATCH 00/78] nd/config-split reroll Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20181027062351.30446-71-pclouds@gmail.com \
    --to=pclouds@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.