From patchwork Wed Jul 24 21:06:17 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: 13741360 Received: from mail-wm1-f46.google.com (mail-wm1-f46.google.com [209.85.128.46]) (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 0D4CC13AA45 for ; Wed, 24 Jul 2024 21:06:23 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.46 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721855185; cv=none; b=j6wrSKpVAfJqTbPnvi9cxvZKBVBG8soirObJ1LrzvUsukqF6QT3yxfeq8rNPARy5PB0f0Sl5FUCg6eQZHmM6mZKpptTcVkrLJyaCFWm1nao5exVBnCrjqJGpJ3WauW8NOrkBBmTjr98dc+5wGVkLTPK8Z6MNAFXR3P1wjKJxMkE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721855185; c=relaxed/simple; bh=ptf9/XRhnLCkGxdU6+IpYEryGjinqZzPz3DNJxqK3R8=; h=Message-Id:In-Reply-To:References:From:Date:Subject:MIME-Version: Content-Type:To:Cc; b=u8n0IE2xp6r8M4sHRC7tjD0xkZnOW43FiBxI1CqZqpT7Qctl/JuYzSlU4E3u6dM9VpuTx9CNjrg9v4ET1A/F3nFKGMfuKaodfuv+JnoAW+hxACs28UJlct0FeL/inhX0VUtszsels3xAvYWqknSsrbpNIdWRIUvJsdP2qER3CG4= 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=d1QHk4gy; arc=none smtp.client-ip=209.85.128.46 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="d1QHk4gy" Received: by mail-wm1-f46.google.com with SMTP id 5b1f17b1804b1-427b4c621b9so1556315e9.1 for ; Wed, 24 Jul 2024 14:06:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1721855182; x=1722459982; 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=AxJmoz8tAJSxV0IPgU16v7QX0c16++1CnGrgJ+b6E78=; b=d1QHk4gyPsu+7so74z03uWofcbjEVeFCjXSThlX87Kv73txTppjvITGCjTuARkxbXm oDetymXYaQh56K3mC+cZB3nUa57yf2qTDMXDqxx0m6LpK4f5nT+URzkZUWArlBQFCOps 6nBiiGhVdvIno1UnGFNvUDfRUo7EZTRoX89pYCxZATBPRm3AxLCzGntytqkquhRbQe3G iL78k3bGypwcekuf3xQf2QdXbBVsvMRCIhzobJ8iujlWWARWDFWlm+xSSPZO4LHbKo3M HadgyT2bxOQNwRPHCTEiNAEk2Zd9xVZprv7m/MxE09MlsrKf6FWH/YPwiihdxeZRkpDO 9//A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721855182; x=1722459982; 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=AxJmoz8tAJSxV0IPgU16v7QX0c16++1CnGrgJ+b6E78=; b=gjw6kV0kY+xbK/2TYgg402H5v4wxHdqjfxoU/Z/Op13nzo4ArnWdeyC81Vuw/+5VFW W7F4xXXZi63ANDbqky5H1d5geubaRw/WqmBc6R/Phw1OgZGC52egjJC3ozlwa3KTnOkg h8XRt3a2Cg/N/xxJ3w06hNROO92UPvMLTbWNZl5md48MqzITG7CGFQW6zn7oyK2v0tCj fWw6wujpUrerOzV2LbUGc+bd2R6LcxLV950p93Sw8vXWh0Bf5FKyjI7f9Z0pLvhpsf9K baKnvWcqZkoOlfjyAlJB8dNlCFWexyl45zFy8ufeAcsEuaLKW9r1QZd5ymmF0u35qNXO DaGA== X-Gm-Message-State: AOJu0YwgyrqfZZF6Xf3JavWSLDjmzC32eoTsJjmhd8SwkgufQ3knfv/f /LKHVYKLmGtJhKtv0A1dWUxVn+lQ34C7P5nP75nP0dFpGTVzF64NEpDQfA== X-Google-Smtp-Source: AGHT+IFapyMSO8wQQ7aLpWKnjlIjlOjIW76YJPQmd8uRDfSCJl4JG575NlIDFqjTFkL4CSfAzFKS4Q== X-Received: by 2002:a05:600c:3b28:b0:426:5cee:4abc with SMTP id 5b1f17b1804b1-4280570fefamr1293425e9.20.1721855181667; Wed, 24 Jul 2024 14:06:21 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-427f9359478sm45698095e9.6.2024.07.24.14.06.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 24 Jul 2024 14:06:21 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Wed, 24 Jul 2024 21:06:17 +0000 Subject: [PATCH v2 1/3] doc: introduce a synopsis custom paragraph attribute 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: =?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?= In order to follow the common manpage usage, the synopsis of the commands needs to be heavily typeset. A first try was performed with using native markup, but it turned out to make the document source almost unreadable, difficult to write and prone to mistakes with unwanted Asciidoc's role attributes. In order to both simplify the writer's task and obtain a consistant typesetting in the synopsis, a custom 'synopsis' paragraph type is created and the backends of asciidoc and asciidoctor take in charge to correctly add the required typesetting. Signed-off-by: Jean-Noël Avila --- Documentation/asciidoc.conf | 12 ++++++++++++ Documentation/asciidoctor-extensions.rb | 17 +++++++++++++++++ t/t0450-txt-doc-vs-help.sh | 11 ++++------- 3 files changed, 33 insertions(+), 7 deletions(-) diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf index 60f76f43edab..08111e98ab33 100644 --- a/Documentation/asciidoc.conf +++ b/Documentation/asciidoc.conf @@ -57,3 +57,15 @@ git-relative-html-prefix= [linkgit-inlinemacro] {target}{0?({0})} endif::backend-xhtml11[] + +ifdef::backend-docbook[] +ifdef::doctype-manpage[] +[paradef-default] +synopsis-style=template="verseparagraph",filter="sed -E 's!([\[ |()>]|^|\])([-=a-zA-Z0-9:+.]+)!\\1\\2!g;s!<[-a-zA-Z0-9.]+>!\\0!g'" +endif::doctype-manpage[] +endif::backend-docbook[] + +ifdef::backend-xhtml11[] +[paradef-default] +synopsis-style=template="verseparagraph",filter="sed -E 's!([\[ |()>]|^|\])([-=a-zA-Z0-9:+.]+)!\\1\\2!g;s!<[-a-zA-Z0-9.]+>!\\0!g'" +endif::backend-xhtml11[] diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index d906a008039c..8c7612743504 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -39,10 +39,27 @@ module Git output end end + + class SynopsisBlock < Asciidoctor::Extensions::BlockProcessor + + use_dsl + named :synopsis + parse_content_as :simple + + def process parent, reader, attrs + outlines = reader.lines.map do |l| + l.gsub(/([\[\] |()>]|^)([-a-zA-Z0-9:+=.]+)/, '\\1{empty}`\\2`{empty}') + .gsub(/(<[-a-zA-Z0-9.]+>)/, '__\\1__') + .gsub(']', ']{empty}') + end + create_block parent, :verse, outlines, attrs + end + end end end Asciidoctor::Extensions.register do inline_macro Git::Documentation::LinkGitProcessor, :linkgit + block Git::Documentation::SynopsisBlock postprocessor Git::Documentation::DocumentPostProcessor end diff --git a/t/t0450-txt-doc-vs-help.sh b/t/t0450-txt-doc-vs-help.sh index 69917d7b8459..f99a69ae1b74 100755 --- a/t/t0450-txt-doc-vs-help.sh +++ b/t/t0450-txt-doc-vs-help.sh @@ -56,14 +56,11 @@ txt_to_synopsis () { fi && b2t="$(builtin_to_txt "$builtin")" && sed -n \ - -e '/^\[verse\]$/,/^$/ { + -E '/^\[(verse|synopsis)\]$/,/^$/ { /^$/d; - /^\[verse\]$/d; - s/_//g; - s/++//g; - s/`//g; - s/{litdd}/--/g; - s/'\''\(git[ a-z-]*\)'\''/\1/g; + /^\[(verse|synopsis)\]$/d; + s/\{litdd\}/--/g; + s/'\''(git[ a-z-]*)'\''/\1/g; p; }' \ From patchwork Wed Jul 24 21:06:18 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: 13741361 Received: from mail-wm1-f51.google.com (mail-wm1-f51.google.com [209.85.128.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 DBE2413B29F for ; Wed, 24 Jul 2024 21:06:24 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.51 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721855187; cv=none; b=Q9UO/SogNlO6WLpCj4qERSLwIRCgB5BtDJSEmt7bmzD6fVxVQpfn3npqCBSTri+5aqamWOHTL8ZfjuCnbTfUPsx93pDD3mY64uvFEkWLLIM0mWowG0Hes3vpkLwICnc6+UuExYwVecrwRyqIzzs6xA0ZXUHy3XmTpmRQDVLPiOM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721855187; c=relaxed/simple; bh=HwOYyNlVu2KoITHjDAubGZsNBBWHEnttgc5RxGbeOQw=; h=Message-Id:In-Reply-To:References:From:Date:Subject:MIME-Version: Content-Type:To:Cc; b=NsJPy+qA6ejnYIhLx+h1zfqtYvI0MzaNvLjdhMPNLgqmq8FESisAAR5TrSJU+lhzec0vFJtqYjmsPZbuAkPlpjKlZCFBjhy1t2UwhnIetvl7t2kLvihA4yIrogURsJq4mNv0+j5rYKc5s5n9K+wDNWcEdUqaUS18TKWLx9tdGl8= 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=QHCqtalH; arc=none smtp.client-ip=209.85.128.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="QHCqtalH" Received: by mail-wm1-f51.google.com with SMTP id 5b1f17b1804b1-4267345e746so1571015e9.0 for ; Wed, 24 Jul 2024 14:06:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1721855182; x=1722459982; 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=6QsUVdBvGykL5WXisV3H8eJK0qTNDV9vrnAt/mwuyp4=; b=QHCqtalHUxIpS7x/hrZ7tjs96vMImZtpxcnwpknWLLaFj0sKaV66szN27TFG0Lg0VA KY2DMfmYNpb2Mm/83HK1IGqbuVKWWk7i6lDnOQ8kX8UB1dLbGpi7xDqi0uhvOSeOTLQo K6R1wyPvT0Sgvj/g2UqPUHW1peDroU7YGEDIQaS1qfDq8cyXrCtfG8AIvB4WwtJMAUa9 hMMi8YLDZCmqaXM4kIV5FLKBJ5JoEEgqUhWo4LQu+NcDjUMVLGsrjyUp3YIt8ZNb5lr4 8VO5WmIrZCBgHh1P3kOzyDEgiWhT6Qd6vmXZYXKk+nx69l/OPrma5mx/LGBrFTFYNVp/ gfpw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721855182; x=1722459982; 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=6QsUVdBvGykL5WXisV3H8eJK0qTNDV9vrnAt/mwuyp4=; b=TlDd9IUzJCzIWvYn3Tkw79smSEDtIF+0Wnf85jm5OVGh0r52DzeqrmPb64Wf82tx8i XKpMQ6WPwPNEBkeY+RvGe/vPYjXFx+jICPOZdboySa3TZPkIisRlD7cmffWcXF7X8b3r haPWoelsaEjlEjRM/aQqkW5HY9lZEgHm7trkonc6Tg6h5GHbSR4Eu2g1wnbng2ea5FnL GnERdF+bWQPNSeEHW7ScGldF9mCSVWweQFSMOtM07w8ySDWmzmE3C1D6JYKNkPFq5Ulx 9xs+wphfMW1a3ige9OBh7h+QqtUt11NSpK6xK8fQ1lJA0OuHwoYgXXMHl4hpcpVOVzSP FtYQ== X-Gm-Message-State: AOJu0YzvcmSC0LaKII2WhtNZRXcFXfroZyeRz1QNUJ3wTPi+L/KTwGhy uxP2nJQtF5EnqOLmEP/2PicQaUzJMb5QaH/SDByGk5IWRpI0nKiyK4pbCA== X-Google-Smtp-Source: AGHT+IEpkONvmm49Q5QNSlsX2AFIzT981kfF4oi4Q3w4BOsVGCyGNP2KNr4I/CK0HHcxjPUiqVZDGg== X-Received: by 2002:a5d:4b83:0:b0:368:319c:9a77 with SMTP id ffacd0b85a97d-36b319e82e9mr545460f8f.29.1721855182536; Wed, 24 Jul 2024 14:06:22 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-427f9386b87sm42820995e9.19.2024.07.24.14.06.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 24 Jul 2024 14:06:22 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Wed, 24 Jul 2024 21:06:18 +0000 Subject: [PATCH v2 2/3] doc: update the guidelines to reflect the current formatting rules 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: =?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/CodingGuidelines | 34 +++++++++++++++++++--------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 1d92b2da03e8..4d59e8f89ec8 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -760,56 +760,60 @@ Markup: Synopsis Syntax - Syntax grammar is formatted neither as literal nor as placeholder. + The synopsis (a paragraph with [synopsis] attribute) is automatically + formatted by the toolchain and does not need typesetting. A few commented examples follow to provide reference when writing or modifying command usage strings and synopsis sections in the manual pages: Possibility of multiple occurrences is indicated by three dots: - __... + ... (One or more of .) Optional parts are enclosed in square brackets: - [__...] + [...] (Zero or more of .) - ++--exec-path++[++=++____] + An optional parameter needs to be typeset with unconstrained pairs + [] + + --exec-path[=] (Option with an optional argument. Note that the "=" is inside the brackets.) - [__...] + [...] (Zero or more of . Note that the dots are inside, not outside the brackets.) Multiple alternatives are indicated with vertical bars: - [`-q` | `--quiet`] - [`--utf8` | `--no-utf8`] + [-q | --quiet] + [--utf8 | --no-utf8] Use spacing around "|" token(s), but not immediately after opening or before closing a [] or () pair: - Do: [`-q` | `--quiet`] - Don't: [`-q`|`--quiet`] + Do: [-q | --quiet] + Don't: [-q|--quiet] Don't use spacing around "|" tokens when they're used to separate the alternate arguments of an option: - Do: ++--track++[++=++(`direct`|`inherit`)]` - Don't: ++--track++[++=++(`direct` | `inherit`)] + Do: --track[=(direct|inherit)] + Don't: --track[=(direct | inherit)] Parentheses are used for grouping: - [(__ | __)...] + [(|)...] (Any number of either or . Parens are needed to make it clear that "..." pertains to both and .) - [(`-p` __)...] + [(-p )...] (Any number of option -p, each with one argument.) - `git remote set-head` __ (`-a` | `-d` | __) + git remote set-head (-a|-d|) (One and only one of "-a", "-d" or "" _must_ (no square brackets) be provided.) And a somewhat more contrived example: - `--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]` + --diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]] Here "=" is outside the brackets, because "--diff-filter=" is a valid usage. "*" has its own pair of brackets, because it can (optionally) be specified only when one or more of the letters is From patchwork Wed Jul 24 21:06:19 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: 13741362 Received: from mail-wm1-f52.google.com (mail-wm1-f52.google.com [209.85.128.52]) (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 406C413B58C for ; Wed, 24 Jul 2024 21:06:25 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.52 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721855187; cv=none; b=kes5VWsq+cmnsxT4OjO8NtBSZyAe7NsLraGjRDZmtlFVE5fEDYdR1sifMvqXiHeUun0I5We/HtliR3kq6LC7OcuCtFbE3PEaEuAugg1iumlzzE8E5UPbIGjQshcjWl2QVmdqRg3/hGoj0i2zI1CQOnmxbPhvd6UtqjrqSbv0AT4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721855187; c=relaxed/simple; bh=X04fEjNN/W/ZyDkTjwIE4A3HTYvwGbGbyzFhXmi3C1Q=; h=Message-Id:In-Reply-To:References:From:Date:Subject:MIME-Version: Content-Type:To:Cc; b=sqGJ6QJIDOnBrUuGwpSBw+z7OLPNdaqGuezj9dD6caoOn0fK8xX1+KQUpmGiCVeK2zMC8qdmtqyyvzRMqatW5e5SV0Nkc1DGuTONi44BMzbIP3qXECgh43tAbO2SdInh9llBbzMjKhMapGCP2Q6qTdCRiWZBWJdhvtaQLRNnudE= 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=Wc3EFSt6; arc=none smtp.client-ip=209.85.128.52 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="Wc3EFSt6" Received: by mail-wm1-f52.google.com with SMTP id 5b1f17b1804b1-4257d5fc9b7so1849065e9.2 for ; Wed, 24 Jul 2024 14:06:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1721855183; x=1722459983; 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=NhyUs2ExxPK/4v314vdlOlE9WAtjc1QBp4qhny3BFn8=; b=Wc3EFSt6smeeRYK9sFyOfUJ34MEuGYvN7ji6WXJdpx81OFHDaE99DwEF1dAhxubwTl Guvd+Bav0y0B6MM4TRQois13j41Ofevx4qBIP1oW8IOfzfYv/mFi7R3rpFHT22wHF2La mXMTzfV+AO2IlWeaH2p/AgCfUudNXfpn4uEMgahB6A2MEXuw8SS/w9bYtIeBoZ+fG7jZ dj0ofgUvm0Q/tInYTgNayFu3O4TATT7o0SqTev5X1XfzTCMZC4MY60jt9f9DY0PwcDui u38RBxmBcy7nGEESFznu1B17tawiQQvpLLh1fT3/CP8xNhlLd6631xzGZ8Wa+58+NPOt dfNQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721855183; x=1722459983; 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=NhyUs2ExxPK/4v314vdlOlE9WAtjc1QBp4qhny3BFn8=; b=qFLyeT1K8LCCqyNnzKqYJDIS8S353cb17nXSrOYYhLTZ2b5PwfG4w1V5/rwYnPGKGb cVcOPxJKVVcN8lBOt+S21UAb8s8A8LJGviqYvz4EhMdBF2+TXUd0xfCdwnw/DATFs0VZ nuTr9gF+XTz1uzajOFrSCLF0F3c4NBv65mH2TFddBsCkthCLBqPHz+MPPexoNYUbqXgu va3w+j44bvTFMHfkn4PEPsFQ5rxaYc8YDx4YExma5lX9PEWskXkYZ13nm7Fu94HR7Hrz uCa/7cgo7rt9qWnM056pRNH6eIxOiILD5vA2FcCk1Cbl1xlLXMPdkWibj41PgjLzVOn2 xshA== X-Gm-Message-State: AOJu0YwJNWZZk55X9ogDLxYATSqFHY1soAY8bYyIIrYMfxJB9vl7I09y 51VcDgbMfZkwstnnUuXWz1SMzK7k4moGn5Yh0+RBPgrPHXDv3jhet7sQQQ== X-Google-Smtp-Source: AGHT+IGAW2rwV1dPEdHkFN3SPKPwzE37YvanitOYuwH80lcGbtgd1WsziC6lFvzfD1mKuBtf7ZnJQw== X-Received: by 2002:adf:9b19:0:b0:367:9c46:198 with SMTP id ffacd0b85a97d-36b319e83a8mr578708f8f.1.1721855183204; Wed, 24 Jul 2024 14:06:23 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-369f7f4e1desm2619794f8f.75.2024.07.24.14.06.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 24 Jul 2024 14:06:22 -0700 (PDT) Message-Id: <2a61e0945deb204547a930614eec431b50b1bd1d.1721855179.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Wed, 24 Jul 2024 21:06:19 +0000 Subject: [PATCH v2 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: =?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 | 20 ++++++++++---------- Documentation/git-init.txt | 12 ++++++------ 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 8e925db7e9c6..53b1c3e23f75 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 ----------- diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index daff93bd164b..eba67fdde83f 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -8,12 +8,12 @@ git-init - Create an empty Git repository or reinitialize an existing one SYNOPSIS -------- -[verse] -`git init` [`-q` | `--quiet`] [`--bare`] [++--template=++____] - [`--separate-git-dir` __] [++--object-format=++____] - [++--ref-format=++____] - [`-b` __ | ++--initial-branch=++____] - [++--shared++[++=++____]] [__] +[synopsis] +git init [-q | --quiet] [--bare] [--template=] + [--separate-git-dir ] [--object-format=] + [--ref-format=] + [-b | --initial-branch=] + [--shared[=]] [] DESCRIPTION