From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-wr1-f45.google.com (mail-wr1-f45.google.com [209.85.221.45]) (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 F23B6183CB0 for ; Sun, 25 May 2025 20:27:13 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.45 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1748204836; cv=none; b=qhL4EGzK9AMlwJf8VqWKnYK6D6dnNnJaa7BBA8pEWKCEnXQxFmxDqcTApMN77+SqXs52fIhc6JPDUpXGJhuEjOmfB2nrQ2s15tyc8WPJPretEyjLn3r7whK93FboeaxhcPWUIIQOCB9JK5XRSG41CSwiZu/Lgda+0jqi3R+oK7c= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1748204836; c=relaxed/simple; bh=puk3dyiUeIC7cHpxl8TkKAgRcyObvZhnTrSGpoN8hm0=; h=Message-Id:In-Reply-To:References:From:Date:Subject:MIME-Version: Content-Type:To:Cc; b=u+m0zZnburJm5nd3+VSRG2j6tAh8k3PN/PYz4zOjrA88zBMDQSir2ir6BCNs/YSE7HyLyfME5KaOQFIH4GdgC8ZrA8wA4OgOAagwzwU41Xvs1M2CvANQT+vT1u7QJb1IVd5/pQ36OQr0ffc8XLOvrBI6B9fzunclgQvSKMmbMWs= 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=cPLRgxe9; arc=none smtp.client-ip=209.85.221.45 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="cPLRgxe9" Received: by mail-wr1-f45.google.com with SMTP id ffacd0b85a97d-3a3673e12c4so993728f8f.2 for ; Sun, 25 May 2025 13:27:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1748204831; x=1748809631; 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=EYnxBtEvB0nJquGAIak6GqZv1KkDX0UzuxEDVYoxb74=; b=cPLRgxe9NPH1uBwjz3XRizMU/s7o+WQ+6TMMp79ws4tGH/t8zfSQAbKYbnGi7tT0TQ tzac0X8u22qLq9+SMnexM7MXBSWq1bpxQRv71ZZq8EvvjkMZxa1Or2H1UpIGNPsLeMFR uhtJjCNuUZgQIu8dQJvuN65tcIuNbEskcYU+KbiciC5mX8DQ7RGol3fkp2EgfkXoUrYs rOsZY6MGDevh9t+Zy2KHO6MZYn2SaqAw48Q0cUuf7FNHBgXmX2f93n5QICF1ZYARy5mb mJexbHDdmWAAygmSsMccXuwCD7fZLNTOJ2tEbiAtShDnz5zfLENueUO5Fkf2bRP3p0fx oT4w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1748204831; x=1748809631; 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=EYnxBtEvB0nJquGAIak6GqZv1KkDX0UzuxEDVYoxb74=; b=Acve2FNeD+9qB38/RM4C58HgBNKinBBoiwsI6AO6oGaZ+ARwzZWRUFgifcOUBDWbCx daFOhmSHBXS9mnu1MOy3jeNPG93+IRunSZh0sVY32rLiJ0FOF8U6WiYwN25OmAl17D+C Bq8xg+PAn7iGLFo7fHT5croG3HFGqa3ZqbL1me72nt6rvaHK3t/ltD4K/uFkMEQX7IBg ndt5vVObuwKoxFk8DyC6sumLo9ls2t8miJQ3Hs9BkkiNw2095Pdxqh2ICGiYuKuAikTU 2k/TC4U2MkP4ov3o0Jp00d3TgJ/SsknE9G5g+ABWxfVqvEt1Bh6tsrFqapYJZImP1uY8 UmNQ== X-Gm-Message-State: AOJu0YycHkU0uTFiEyuNcPkxue/nTDPAKRJ4x4Umxx0mivC3QtQ+9xXR cRWGk6nHw1GEK/6I6m5lKFrvPnqEmBMmSZhNFjUz59UdpYq8L1o7shbBQjNErA== X-Gm-Gg: ASbGnctH8vc2WPPFyprtEBsowBfNS1KYAbJsrSgoPRjGmZPPGsmspt4AWcV1qPSy2Gw U7Ydb4bX1fgYNch01rkHvl4J3fLiet6+uCEQPq1c6w0bdRmc1n5Rfl9rhzCDTDQ68NfumutbGxt ySQpa10kM+sRdnmhGrDLryc/0GBVjmtV0r4+KG2zqG5cWpp9wASllrzYdvzp2kuobfKl0tnfNl0 tFwGsnmZ32xxNjFAojG1/8yHEcQoYoemLz1xe8tQoZEbjhwPeVrF4VxZ+qhWv81pNURUeaiFA2t hQ1n0eYO3wPA+5KPxGJucrXHEdYivIXPm5zCx0EBSQxefPwsq0w7 X-Google-Smtp-Source: AGHT+IF/n073eAq8636YNFaARib2qThpOhB7mt0UL1ZmrmI8rf8bg7qIe+MSk5blRT2nq59ERp+zqg== X-Received: by 2002:a5d:4d50:0:b0:3a4:d004:94ac with SMTP id ffacd0b85a97d-3a4d004968dmr3422066f8f.40.1748204831145; Sun, 25 May 2025 13:27:11 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3a4c591c044sm7534322f8f.52.2025.05.25.13.27.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 25 May 2025 13:27:10 -0700 (PDT) Message-Id: <23eef28b5a4b33219e92e1462688df1bb11e522f.1748204829.git.gitgitgadget@gmail.com> In-Reply-To: References: From: "=?UTF-8?q?Jean-No=C3=ABl=20Avila?= via GitGitGadget" Date: Sun, 25 May 2025 20:27:01 +0000 Subject: [PATCH 1/9] doc: convert git-checkout manpage to new style Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fcc: Sent To: git@vger.kernel.org Cc: =?UTF-8?Q?Jean-No=C3=ABl?= Avila , =?UTF-8?q?Jean-No=C3=ABl=20Avila?= From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= - Switch the synopsis to a synopsis block which will automatically format placeholders in italics and keywords in monospace - Use __ instead of in the description - Use `backticks` for keywords and more complex option descriptions. The new rendering engine will apply synopsis rules to these spans. Signed-off-by: Jean-Noël Avila --- Documentation/config/checkout.adoc | 14 +- Documentation/git-checkout.adoc | 228 ++++++++++++++--------------- 2 files changed, 121 insertions(+), 121 deletions(-) diff --git a/Documentation/config/checkout.adoc b/Documentation/config/checkout.adoc index a32302299380..e35d21296978 100644 --- a/Documentation/config/checkout.adoc +++ b/Documentation/config/checkout.adoc @@ -1,9 +1,9 @@ -checkout.defaultRemote:: +`checkout.defaultRemote`:: When you run `git checkout ` or `git switch ` and only have one remote, it may implicitly fall back on checking out and tracking e.g. `origin/`. This stops working as soon - as you have more than one remote with a `` + as you have more than one remote with a __ reference. This setting allows for setting the name of a preferred remote that should always win when it comes to disambiguation. The typical use-case is to set this to @@ -12,17 +12,17 @@ checkout.defaultRemote:: Currently this is used by linkgit:git-switch[1] and linkgit:git-checkout[1] when `git checkout ` or `git switch ` -will checkout the `` branch on another remote, +will checkout the __ branch on another remote, and by linkgit:git-worktree[1] when `git worktree add` refers to a remote branch. This setting might be used for other checkout-like commands or functionality in the future. -checkout.guess:: +`checkout.guess`:: Provides the default value for the `--guess` or `--no-guess` option in `git checkout` and `git switch`. See linkgit:git-switch[1] and linkgit:git-checkout[1]. -checkout.workers:: +`checkout.workers`:: The number of parallel workers to use when updating the working tree. The default is one, i.e. sequential execution. If set to a value less than one, Git will use as many workers as the number of logical cores @@ -30,13 +30,13 @@ checkout.workers:: all commands that perform checkout. E.g. checkout, clone, reset, sparse-checkout, etc. + -Note: Parallel checkout usually delivers better performance for repositories +NOTE: Parallel checkout usually delivers better performance for repositories located on SSDs or over NFS. For repositories on spinning disks and/or machines with a small number of cores, the default sequential checkout often performs better. The size and compression level of a repository might also influence how well the parallel version performs. -checkout.thresholdForParallelism:: +`checkout.thresholdForParallelism`:: When running parallel checkout with a small number of files, the cost of subprocess spawning and inter-process communication might outweigh the parallelization gains. This setting allows you to define the minimum diff --git a/Documentation/git-checkout.adoc b/Documentation/git-checkout.adoc index a66c53a5cd1e..ee83b6d9ba9a 100644 --- a/Documentation/git-checkout.adoc +++ b/Documentation/git-checkout.adoc @@ -7,54 +7,54 @@ git-checkout - Switch branches or restore working tree files SYNOPSIS -------- -[verse] -'git checkout' [-q] [-f] [-m] [] -'git checkout' [-q] [-f] [-m] --detach [] -'git checkout' [-q] [-f] [-m] [--detach] -'git checkout' [-q] [-f] [-m] [[-b|-B|--orphan] ] [] -'git checkout' [-f] [--] ... -'git checkout' [-f] --pathspec-from-file= [--pathspec-file-nul] -'git checkout' [-f|--ours|--theirs|-m|--conflict=