From patchwork Tue Sep 24 07:08:50 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: 13810231 Received: from mail-lf1-f51.google.com (mail-lf1-f51.google.com [209.85.167.51]) (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 0FBA712DD95 for ; Tue, 24 Sep 2024 07:08:57 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.167.51 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1727161740; cv=none; b=ms3jh4jKUEboC0hp08a7qq8UKdpKtsiTDdS1WqvNJj4qUfVSvwEzZtty+ZxqJaxG3T9SKUdSMFPL54h7XM3oAA751HHvv6BVGTH9bWDULuysVdpM5Mnh9q0ZVSRo0POFi62bXIF4vW1dYkM8gIAl500BpOR0v/3swqvcVz7sR/M= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1727161740; 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=qviLO9d91R/gZvx0WI4rCihGT0oQXbLHMfsGhS90veEIBGnH4BUjeN+UN80kgC7wXp9iXG6/QCHFIrx+ULcfE7hPBZ0gWrrzvESEb9UCUg+nLcpOYCgHdt4oPtInihasVZ03h+zVad3heUcKYTgYucfCw85cLAuXDSXsisQdQ9Q= 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=EbEEACg5; arc=none smtp.client-ip=209.85.167.51 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="EbEEACg5" Received: by mail-lf1-f51.google.com with SMTP id 2adb3069b0e04-5365aa568ceso6015433e87.0 for ; Tue, 24 Sep 2024 00:08:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1727161736; x=1727766536; 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=EbEEACg5PZZRtB+GIzoSX3UcIjo6VTv+gQI44Y5j45DNePSOBMcaOYphqZrKmtEohG Da+k/fSq64T4evfb5kUJF/p04BaHKI1KNETN/lfKZB8AzvzFi06NwpfGRYUYepxmHWxU QXXgHlckDL9e1XOjwxIFxPMcvbmG/Y9DZ51giZFRthxAY4TW+EkoV2ZiI/t7ICi1YQRl d4+7TqFUyngJv/ktp6bCY3BgGOPIVmfsaQXAYHSCvtflkdg0wdMkCy3lxtmZRG3dCfXR D2umxCrTj2NrogTLv2bVtE89PZ1Ed+AJD1vn/VHQOnAwIhGVFNkWUSbPRG+3LTlEkqQW AxPQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1727161736; x=1727766536; 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=XMEQDzLRolErv4R8B1klzduoTUxKwerTFbilMcBuUhqOXSrX/TmznFcUp31KwIbmhF jsp5taSrlPQRWFZ4/Vt+Kqrve2BR+so9S5oIsg5y8eutKpg/sDINZ1F0V5mlmywT2Uuh Y6I3pyNjJPRMNuuYlIrOae9Lpfl9D2Q4ycNNg5D++rVO8EC0ykqsAfNy5l9rMrrhyd4Q OIMvynsK1zECcVAIy9CyJEhMxno3Wa+m0oCa4hWc4AvoGlOcvA+8px95DUaj91puaWDV W5vJoGB8ZomZhHLn38yFS2P/tUE6AZv37JS8fQnM3KacnBP4DWFQi1HEMdORckPH1rEm bqmA== X-Gm-Message-State: AOJu0YwZK1VN00DVTYgaYdjXLnruuglw8nuP9PeFkmAyNzHzLXhDY+NQ Z6neXYliN/EusUIpa+HmV/+fr9HptCVUlUKuVU8fj/WHsCvV+QNJ26xBvA== X-Google-Smtp-Source: AGHT+IE6eH49HiziPIy2bqHqIm3A6e5NDPLE1dEpbuA6Q/TukwLtNsTU2qnUrQM1H1pM8lTC57gLOw== X-Received: by 2002:a05:6512:6d1:b0:52c:d628:c77c with SMTP id 2adb3069b0e04-536ac32f044mr9626223e87.43.1727161735249; Tue, 24 Sep 2024 00:08:55 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id a640c23a62f3a-a9392f4f8b1sm48187166b.53.2024.09.24.00.08.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 24 Sep 2024 00:08:54 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Tue, 24 Sep 2024 07:08:50 +0000 Subject: [PATCH v5 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 , Josh Steadmon , Chris Torek , =?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=++__