From patchwork Fri Mar 29 11:19:40 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Jean-No=C3=ABl_Avila?= X-Patchwork-Id: 13610561 Received: from mail-wm1-f49.google.com (mail-wm1-f49.google.com [209.85.128.49]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 4E5DB6A356 for ; Fri, 29 Mar 2024 11:19:52 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.49 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711711194; cv=none; b=CwSRwv+aCtCRwHGW61++mdMbcVR9miqUe+V0eqEkjsqvjzlQCze+sw7FrW+5mzCQk7+yV+LP/twVoiqm4iAvW7L/OVs6+VpavLeUQnsn2A63vIhm9SF+9hTZiFa1em7+pTWH5SA3clY/HhMIRQwus6ui2x1WgerKPoo+zo/Q5NM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711711194; c=relaxed/simple; bh=PjSDA40giwmlksrjGH2K68Ln7JHe+/E2EgxjtBIVPxM=; h=Message-Id:In-Reply-To:References:From:Date:Subject:MIME-Version: Content-Type:To:Cc; b=MfFzhwXDUvQ6TBFKCh3ny+eB6KGhTniMhc7rlV933YRMIBWuSrGd4ksMwqGhtzLOrMY+IZOF3HM08OMLmIdFNzXauH8Yp8eoRWeDZ67IshejAErUX3Owz9Upq80nrXSDMsEdRWMgUG7ntfbV/adTLQwbBljA7aPrkj3I1i1as2A= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=lrlGTtsA; arc=none smtp.client-ip=209.85.128.49 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="lrlGTtsA" Received: by mail-wm1-f49.google.com with SMTP id 5b1f17b1804b1-4151d2322caso12324305e9.0 for ; Fri, 29 Mar 2024 04:19:51 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1711711190; x=1712315990; darn=vger.kernel.org; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=xAzHRV7l+HXfCreqkBUKUrtuZRGvJMPw9Cg0wSG3/Wo=; b=lrlGTtsAnVjqH0qLNhxgGypBayKuCs798KiqreRuSCjfSW2ITe5B94St7ZFd2YKlRc C9g/7iRcZGp7fFpJ+5AA/36NopQVorwbAn9l59i2yfWGBJS2lorMicMTETaE6uDbNrgN FuIrtwL4AadUkAWmuVz97yuWqc1aJ0TtuPJyraUZEMNTdXKhA3T1JnA4oT15SrPq7rDK WnntbOkP5ORDlwSj38BA2XCFB4aMaFCa1K7VMD6Ln1sV/sWzmZKTqHdhFXZ43U+vzy9L bJxrrVhTez1Uqawwrty8xdiGnKxbNzLmpyOM+pBzVDe5y44aEExxpyirOOR+HDJV6CfW 4AwQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1711711190; x=1712315990; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=xAzHRV7l+HXfCreqkBUKUrtuZRGvJMPw9Cg0wSG3/Wo=; b=aFJ7AyxdQkhpTKJA5DG423ODOvkILmSXyGQQJiFXYZ1Q6G08txx7Iej1WJHqP6xo0n YxZ5LtE/IiznQFtSGyeo7xNP3SSmTn5POAG7OeTAsoArGuNOl6hQMRLTxf0524AbzfDZ jeM8d0LyEp4U55xOr2eLUVAZOmZaewYM6nMo6IPCmBAod2jBCCJCLuPGXcAzfsivI2xb 8H5BO92XRtgrB/8Q6tLBEdbp9EvpWol/oDfOe9q8y/Ery7M8m33o82lBYil4nKyLi7TT IgmW5P8j9YdM+v9Nt/wW8FfgyN6FCh+hL9dwoLsZaqz0gDIRLTYcvySYhJNPpcM3P+5j zqZg== X-Gm-Message-State: AOJu0YwqvwW8za5kqN+Ih7gfAoa+BgSh3HCR48VPE/nynVWGYXJO5AHy tYMMxmyzr+RuQeHB9H6n/8KEnmM7BRbDeObrdukb+BSa0Vf2WxHmO8a6/Bnz X-Google-Smtp-Source: AGHT+IG2OjpNN4Jd+ntorCzlBFC0L+1ypPOYT4EBdbthrlPjnnAKiHI/hyT49XqORDR7KXGdu5tu9Q== X-Received: by 2002:a05:600c:4f0c:b0:414:5e92:cbd8 with SMTP id l12-20020a05600c4f0c00b004145e92cbd8mr1605648wmq.1.1711711189402; Fri, 29 Mar 2024 04:19:49 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id q17-20020a05600c46d100b0041409db0349sm5101122wmo.48.2024.03.29.04.19.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Mar 2024 04:19:47 -0700 (PDT) Message-Id: <54c2012429d5fcc6cf16acaa823e3fc8d9025dbf.1711711182.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Fri, 29 Mar 2024 11:19:40 +0000 Subject: [PATCH v2 4/5] doc: git-clone: apply new documentation formatting guidelines Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: Martin =?utf-8?b?w4VncmVu?= , Jeff King , Eric Sunshine , =?utf-8?q?Jean-No=C3=ABl?= Avila , =?utf-8?q?Jean-No?= =?utf-8?q?=C3=ABl_Avila?= From: =?utf-8?q?Jean-No=C3=ABl_Avila?= From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= Signed-off-by: Jean-Noël Avila --- Documentation/config/clone.txt | 6 +- Documentation/git-clone.txt | 120 ++++++++++++++++----------------- Documentation/urls.txt | 44 ++++++------ 3 files changed, 86 insertions(+), 84 deletions(-) diff --git a/Documentation/config/clone.txt b/Documentation/config/clone.txt index d037b57f729..71a967f262d 100644 --- a/Documentation/config/clone.txt +++ b/Documentation/config/clone.txt @@ -1,13 +1,13 @@ -clone.defaultRemoteName:: +`clone.defaultRemoteName`:: The name of the remote to create when cloning a repository. Defaults to `origin`, and can be overridden by passing the `--origin` command-line option to linkgit:git-clone[1]. -clone.rejectShallow:: +`clone.rejectShallow`:: Reject cloning a repository if it is a shallow one; this can be overridden by passing the `--reject-shallow` option on the command line. See linkgit:git-clone[1] -clone.filterSubmodules:: +`clone.filterSubmodules`:: If a partial clone filter is provided (see `--filter` in linkgit:git-rev-list[1]) and `--recurse-submodules` is used, also apply the filter to submodules. diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index f90977a8519..5de18de2ab8 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -9,15 +9,15 @@ git-clone - Clone a repository into a new directory SYNOPSIS -------- [verse] -'git clone' [--template=] - [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror] - [-o ] [-b ] [-u ] [--reference ] - [--dissociate] [--separate-git-dir ] - [--depth ] [--[no-]single-branch] [--no-tags] - [--recurse-submodules[=]] [--[no-]shallow-submodules] - [--[no-]remote-submodules] [--jobs ] [--sparse] [--[no-]reject-shallow] - [--filter= [--also-filter-submodules]] [--] - [] +`git clone` [++--template=++____] + [`-l`] [`-s`] [`--no-hardlinks`] [`-q`] [`-n`] [`--bare`] [`--mirror`] + [`-o` __] [`-b` __] [`-u` __] [`--reference` __] + [`--dissociate`] [`--separate-git-dir` __] + [`--depth` __] [`--`[`no-`]`single-branch`] [`--no-tags`] + [++--recurse-submodules++[++=++____]] [`--`[`no-`]`shallow-submodules`] + [`--`[`no-`]`remote-submodules`] [`--jobs` __] [`--sparse`] [`--`[`no-`]`reject-shallow`] + [++--filter=++____] [`--also-filter-submodules`]] [`--`] __ + [__] DESCRIPTION ----------- @@ -31,7 +31,7 @@ currently active branch. After the clone, a plain `git fetch` without arguments will update all the remote-tracking branches, and a `git pull` without arguments will in addition merge the remote master branch into the -current master branch, if any (this is untrue when "--single-branch" +current master branch, if any (this is untrue when `--single-branch` is given; see below). This default configuration is achieved by creating references to @@ -42,12 +42,12 @@ configuration variables. OPTIONS ------- --l:: ---local:: +`-l`:: +`--local`:: When the repository to clone from is on a local machine, this flag bypasses the normal "Git aware" transport mechanism and clones the repository by making a copy of - HEAD and everything under objects and refs directories. + `HEAD` and everything under objects and refs directories. The files under `.git/objects/` directory are hardlinked to save space when possible. + @@ -67,14 +67,14 @@ links. source repository, similar to running `cp -r src dst` while modifying `src`. ---no-hardlinks:: +`--no-hardlinks`:: Force the cloning process from a repository on a local filesystem to copy the files under the `.git/objects` directory instead of using hardlinks. This may be desirable if you are trying to make a back-up of your repository. --s:: ---shared:: +`-s`:: +`--shared`:: When the repository to clone is on the local machine, instead of using hard links, automatically setup `.git/objects/info/alternates` to share the objects @@ -101,7 +101,7 @@ If you want to break the dependency of a repository cloned with `--shared` on its source repository, you can simply run `git repack -a` to copy all objects from the source repository into a pack in the cloned repository. ---reference[-if-able] :: +`--reference`[`-if-able`] __:: If the reference __ is on the local machine, automatically setup `.git/objects/info/alternates` to obtain objects from the reference __. Using @@ -115,7 +115,7 @@ objects from the source repository into a pack in the cloned repository. *NOTE*: see the NOTE for the `--shared` option, and also the `--dissociate` option. ---dissociate:: +`--dissociate`:: Borrow the objects from reference repositories specified with the `--reference` options only to reduce network transfer, and stop borrowing from them after a clone is made @@ -126,43 +126,43 @@ objects from the source repository into a pack in the cloned repository. same repository, and this option can be used to stop the borrowing. --q:: ---quiet:: +`-q`:: +`--quiet`:: Operate quietly. Progress is not reported to the standard error stream. --v:: ---verbose:: +`-v`:: +`--verbose`:: Run verbosely. Does not affect the reporting of progress status to the standard error stream. ---progress:: +`--progress`:: Progress status is reported on the standard error stream by default when it is attached to a terminal, unless `--quiet` is specified. This flag forces progress status even if the standard error stream is not directed to a terminal. ---server-option=