From patchwork Thu Sep 5 21:52:06 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: 13793011 Received: from mail-lj1-f174.google.com (mail-lj1-f174.google.com [209.85.208.174]) (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 658121B1505 for ; Thu, 5 Sep 2024 21:52:13 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.208.174 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1725573135; cv=none; b=Iq+E2E2TZ8GqsRoGYK9FCYqg7YuZpIEKiyzcTogA9Mq1HZA05mtz9AW1zXM7r/l5hzwfDkw4xAhYsLjgPzzdjTnT7Rmm8GScqMDsF3/LOBuumyfVNea/RC9E3hntZ/gmLCiMi5rWrCjaAzD3POuQeWPvH1fGGkrI6RUL7EFJYvc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1725573135; c=relaxed/simple; bh=Eaqgis0uSVGgXcr2Jmt79yrqrhPXTWxp+V+pT+l53MY=; h=Message-Id:In-Reply-To:References:From:Date:Subject:MIME-Version: Content-Type:To:Cc; b=BxgSDhh2tQfiPUGVN5pE/ka/R71ErO6YCXFzX+SZinrhUWwa7fVKVfdLqUTHODmGjtO6bT+SRFc2G4vqpfUA0P6049iIE9cunJ83OWc14XAJTQO/P/pWvtX9eugniK5c3s0OPMALw1C3ZDP6o4yNcd8/Zu7XUZbkR3cugEARSus= 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=JDqABsQ4; arc=none smtp.client-ip=209.85.208.174 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="JDqABsQ4" Received: by mail-lj1-f174.google.com with SMTP id 38308e7fff4ca-2f50ca18a13so15933931fa.1 for ; Thu, 05 Sep 2024 14:52:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1725573131; x=1726177931; 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=/qrMXREWBZ2YGOF2rrmabikA8Un0b7umLT0leYeINvA=; b=JDqABsQ4Y5sMkSGzIIxi4lRI6ZfnK1ODpLiEzFIXSgJjplqS6jWGYFvhwIqzfbUmXD FkKEr5KTlAOP4G8xn+AIsFcSVMv4scmrNI4PCK8hFdZlwDLuUMWw1LDu8h/BBOSyImY3 9mw82cJOJz21h/8OCYgVcnYBzqmaYUTZ3ZMv7mDuu5Vcbi2hJmomRjfK0fT2ceBWbxys 8EF21Vf9kj/bpbyve0aZN3ue8h2G26t7uWGtfptLum7Ebr7+wnGJWC1mILla3YoSWVi7 rBQ/XBXIJMbpBUxnsEmG0Oq741JTSfxicZ4vs2lU7VqeM7KmMzz7WD3ahABY2rAl/YeA GRBQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1725573131; x=1726177931; 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=/qrMXREWBZ2YGOF2rrmabikA8Un0b7umLT0leYeINvA=; b=hREbHjO03y6MMO+XgALZSG5JO6ZWDXO6xT8NWKwsR0LipWdpvD7ohWtHU5nWAvWpZ8 JfO8zu56icNwnXQxjKyE2sxltUlSJACBbwA0PyzFU1AUaExtZkkM8TQc1YbYHbq81M9b jWEayuHgRiANgVsvjOmNvdriWgqR2ZS96NYzi1DjcTn90jniDmkFB70fF8lG0IAnOTW0 P93RR0keIOChRfqPTpvgmpegWmUqDoehCZsTLDAp0BNdBpNtsnHYRBrTLS2Rna4YN4P4 XHzfj9Whx1H+RKkXIM2xEE7VORVoN7t7kWwpnch4fM9C7pbCumVNtxGDYHnJ3R/U4Nq2 jXdQ== X-Gm-Message-State: AOJu0YyU4mTdM8LRTZUK7BBFRMMxp1hRaugfxFJ7MyIlnueDc2AYQjwQ tbtZCEz/wHKIXaZJtcZk2xxQwEbRoKjzPkkIyUAkYdOVTCJKdHxI0Yk5rw== X-Google-Smtp-Source: AGHT+IF5NiTF9Q8gKu090uKvFQF39InD0psbxJ5WRB5uqbxMG7yYqFdM3mZeg02sx/7rwQL+ykk5Qw== X-Received: by 2002:a05:651c:b13:b0:2f1:6cb1:44c0 with SMTP id 38308e7fff4ca-2f61038c633mr195528401fa.6.1725573130398; Thu, 05 Sep 2024 14:52:10 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id 4fb4d7f45d1cf-5c3cc56d405sm1680401a12.50.2024.09.05.14.52.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 05 Sep 2024 14:52:09 -0700 (PDT) Message-Id: <719188da711f9e2f66dea706b3df28e4930fa060.1725573126.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 05 Sep 2024 21:52:06 +0000 Subject: [PATCH v4 3/3] doc: apply synopsis simplification on git-clone and git-init 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: 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?= With the new synopsis formatting backend, no special asciidoc markup is needed. Signed-off-by: Jean-Noël Avila --- Documentation/git-clone.txt | 78 ++++++++++++++++++------------------- Documentation/git-init.txt | 35 +++++++---------- Documentation/urls.txt | 26 ++++++------- 3 files changed, 67 insertions(+), 72 deletions(-) diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 8e925db7e9c..9c13f847da3 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -8,16 +8,16 @@ 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-`]{empty}`single-branch`] [`--no-tags`] - [++--recurse-submodules++[++=++____]] [++--++[++no-++]{empty}++shallow-submodules++] - [`--`[`no-`]{empty}`remote-submodules`] [`--jobs` __] [`--sparse`] [`--`[`no-`]{empty}`reject-shallow`] - [++--filter=++____] [`--also-filter-submodules`]] [`--`] __ - [__] +[synopsis] +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 ----------- @@ -52,7 +52,7 @@ OPTIONS to save space when possible. + If the repository is specified as a local path (e.g., `/path/to/repo`), -this is the default, and --local is essentially a no-op. If the +this is the default, and `--local` is essentially a no-op. If the repository is specified as a URL, then this flag is ignored (and we never use the local optimizations). Specifying `--no-local` will override the default when `/path/to/repo` is given, using the regular @@ -64,8 +64,8 @@ prevent the unintentional copying of files by dereferencing the symbolic links. + *NOTE*: this operation can race with concurrent modification to the -source repository, similar to running `cp -r src dst` while modifying -`src`. +source repository, similar to running `cp -r ` while modifying +__. `--no-hardlinks`:: Force the cloning process from a repository on a local @@ -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 @@ -142,17 +142,17 @@ objects from the source repository into a pack in the cloned repository. is specified. This flag forces progress status even if the standard error stream is not directed to a terminal. -++--server-option=++__