From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-wm1-f44.google.com (mail-wm1-f44.google.com [209.85.128.44]) (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 F302B1E0B9C for ; Sun, 29 Jun 2025 13:20:51 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.44 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1751203254; cv=none; b=bqjXCdDcqsqjZhcHf+wqM1zqMR2KRr82GEZWLTm8T0Z6/lWXffm52srIcYo7rbXnU3hAEty8P4ic1qOVFRVaK9EzpkR3ZIQUuAz1rdfWmIfkC8/MifRPHeBjEcB1l1rFTtteW7dd18zVjeJ17RrooQ9zhzE5l0eUWe/YghB93sU= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1751203254; c=relaxed/simple; bh=PDHnHkSSUgBxUBvmwnrqgC0LjmQqFdXdaj/UZQZjn9A=; h=Message-Id:In-Reply-To:References:From:Date:Subject:MIME-Version: Content-Type:To:Cc; b=RU6nm1ykG3otRWyO4kKN36JrmfEaZjXI/AbK5bX3BDohVas5EO98KwpZxDImdbJh6w86usf3ej2LXLrJPgT6f28J8wRPlRwi0It6c4hBxxZXYlFNTBmrWO7LEFQC+fSDfZNLe91SSQPj0G0kSCWn0YY/Onrd5NFsiGf/hRBkmRU= 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=MTU/DrMn; arc=none smtp.client-ip=209.85.128.44 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="MTU/DrMn" Received: by mail-wm1-f44.google.com with SMTP id 5b1f17b1804b1-451d3f72391so13828395e9.3 for ; Sun, 29 Jun 2025 06:20:51 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1751203250; x=1751808050; 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=cNd/4CRkSjgK5ac5Hfb3cR3Ox5u0b7mkCjQVZuSRMQs=; b=MTU/DrMneq54kjbtqT4p4wzAqedpvoXDgScbxNSHBPtgi+wawcs1ESyWFnFIvbGO9i xQPDudGjFBPN1g6Q7wIltRKgEVJT0j5EcNyeT8m2NhDcsQNspIH9Q/501WVP1qzLxfSL U6B5/D4z2G9IwI/D8iBIV16+HxeHIpdo0VgyEfxL3AM5+0lq3XHdHIzdK5DjjDt0mb3a DFB/9gmNOz4fvbLW9fLU8odFYsic/B0B+yJaRRCRLzExAIDkjHwEyS47zLuCIUkwqqY6 PQxkpxJ4GlR+jlZH65WvpgtTrU9BPzhtJhT940eTFyLghw0OEdwoyWD4rrKcLw/Df4Be CbKQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1751203250; x=1751808050; 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=cNd/4CRkSjgK5ac5Hfb3cR3Ox5u0b7mkCjQVZuSRMQs=; b=rY1to0y44E83MpFpQ4Xt9Yvhs5HRJfaNfwqt+M3bMdaui9j4ZMxgJUyef/PvbtgujD 8j34sIKqvT2BedcyFgbpkwij9YYn3mt0GiWm8ev/+0gT2VfKHL5+E6ASOuvvaRnHhxCZ 7GMF6bXG/mBSk7ZnepYrvxJgakEp5f+Vvv1IqkdilC2ap+JZUtZy0a9ndE3Eybz++nkw austBRjKDYhZW7IEnj9Y9vVB92Y2mXAaRoXEbeZZoGyRJUUj0o3WpDe4auyR3CXEBSfD XDZHa7HVRPw8HW1viO8vkZH675D3lzPvjtcZRqtXRN0KPNmR7xAfMhN1i0OhQx8jZ7qP yNJg== X-Gm-Message-State: AOJu0YwHJi81/789x3MJnhXyqgIlJBTWDq8/TeRA9CTWJfLgPY7JXKpe cITNVukscVygtrPDBpQ+QaYAwYO1juNSV8HMfiDlV2lbjrN/a9SSO/UKKzoRdA== X-Gm-Gg: ASbGncsQCnejv9SLDaBI+FX1tRgCrEUI8NM3XxcgR4oDHzbdukXdmH5paq+qsls+rj4 vE8mwHT9Qy3KUusVDWbyb6s9+lyojWymBlLZAHJiSzzjpeDErSof8d71kFbHSZs0tQoGKn6mAX+ NMc2lDRs9jjxjFp74eDKOUHyS+ZAMzxkOrkyO3YRjOehnlkqoch7cFZ41kdH2nWbivPgQuDe9iY zc7sa8F0Bjx+RTbo/kxl/ezIMRzb11TYDv7jYyguThm45q69urXU+usO3er9+Qn6F+9CcpBwaOT sjNc4700a8CS3rlFTHWWDeRkYL+GEircrrbiGO0tKeeY6fO5B8D/SNPUj3p1e/8= X-Google-Smtp-Source: AGHT+IGmf73kwW/+Fw6jIyFbTjD25E7VtTEFKqHgQx7DShMDgJ+4o0+2gspZp8P1vPinEbikw+IxTw== X-Received: by 2002:a7b:cde1:0:b0:453:2066:4a26 with SMTP id 5b1f17b1804b1-4538ee71293mr83955675e9.16.1751203249708; Sun, 29 Jun 2025 06:20:49 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3a892e597a8sm7703625f8f.70.2025.06.29.06.20.48 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 29 Jun 2025 06:20:48 -0700 (PDT) Message-Id: In-Reply-To: References: From: "=?UTF-8?q?Jean-No=C3=ABl=20Avila?= via GitGitGadget" Date: Sun, 29 Jun 2025 13:20:39 +0000 Subject: [PATCH v2 7/9] doc: git-log: convert pretty formats to new doc format 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?= - 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. For all the formats in the form of %(foo), the formatting needs to be heavier because we not want the parentheses to be rendered as syntax elements,but as keywords, i.e. we need to circumvent the syntax highlighting of synopsis. In this particular case, this requires the heavy escaping of the parts that contain parentheses with ++. Signed-off-by: Jean-Noël Avila --- Documentation/pretty-formats.adoc | 283 +++++++++++++++--------------- 1 file changed, 143 insertions(+), 140 deletions(-) diff --git a/Documentation/pretty-formats.adoc b/Documentation/pretty-formats.adoc index 07475de8c337..9ed0417fc811 100644 --- a/Documentation/pretty-formats.adoc +++ b/Documentation/pretty-formats.adoc @@ -2,11 +2,11 @@ PRETTY FORMATS -------------- If the commit is a merge, and if the pretty-format -is not 'oneline', 'email' or 'raw', an additional line is -inserted before the 'Author:' line. This line begins with +is not `oneline`, `email` or `raw`, an additional line is +inserted before the `Author:` line. This line begins with "Merge: " and the hashes of ancestral commits are printed, separated by spaces. Note that the listed commits may not -necessarily be the list of the *direct* parent commits if you +necessarily be the list of the 'direct' parent commits if you have limited your view of history: for example, if you are only interested in changes related to a certain directory or file. @@ -14,24 +14,24 @@ file. There are several built-in formats, and you can define additional formats by setting a pretty. config option to either another format name, or a -'format:' string, as described below (see +`format:` string, as described below (see linkgit:git-config[1]). Here are the details of the built-in formats: -* 'oneline' +* `oneline` + This is designed to be as compact as possible. -* 'short' +* `short` commit Author: -* 'medium' +* `medium` commit Author: @@ -41,7 +41,7 @@ This is designed to be as compact as possible. -* 'full' +* `full` commit Author: @@ -51,7 +51,7 @@ This is designed to be as compact as possible. -* 'fuller' +* `fuller` commit Author: @@ -63,18 +63,18 @@ This is designed to be as compact as possible. -* 'reference' +* `reference` (, ) + This format is used to refer to another commit in a commit message and -is the same as `--pretty='format:%C(auto)%h (%s, %ad)'`. By default, +is the same as ++--pretty=\'format:%C(auto)%h (%s, %ad)'++. By default, the date is formatted with `--date=short` unless another `--date` option is explicitly specified. As with any `format:` with format placeholders, its output is not affected by other options like `--decorate` and `--walk-reflogs`. -* 'email' +* `email` From From: @@ -83,30 +83,30 @@ placeholders, its output is not affected by other options like -* 'mboxrd' +* `mboxrd` + -Like 'email', but lines in the commit message starting with "From " +Like `email`, but lines in the commit message starting with "From " (preceded by zero or more ">") are quoted with ">" so they aren't confused as starting a new commit. -* 'raw' +* `raw` + -The 'raw' format shows the entire commit exactly as +The `raw` format shows the entire commit exactly as stored in the commit object. Notably, the hashes are -displayed in full, regardless of whether --abbrev or ---no-abbrev are used, and 'parents' information show the +displayed in full, regardless of whether `--abbrev` or +`--no-abbrev` are used, and 'parents' information show the true parent commits, without taking grafts or history simplification into account. Note that this format affects the way commits are displayed, but not the way the diff is shown e.g. with `git log --raw`. To get full object names in a raw diff format, use `--no-abbrev`. -* 'format:' +* `format:` + -The 'format:' format allows you to specify which information +The `format:` format allows you to specify which information you want to show. It works a little bit like printf format, -with the notable exception that you get a newline with '%n' -instead of '\n'. +with the notable exception that you get a newline with `%n` +instead of `\n`. + E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"' would show something like this: @@ -120,158 +120,161 @@ The title was >>t4119: test autocomputing -p for traditional diff input.<< The placeholders are: - Placeholders that expand to a single literal character: -'%n':: newline -'%%':: a raw '%' -'%x00':: '%x' followed by two hexadecimal digits is replaced with a +++%n++:: newline +++%%++:: a raw ++%++ +++%x00++:: ++%x++ followed by two hexadecimal digits is replaced with a byte with the hexadecimal digits' value (we will call this "literal formatting code" in the rest of this document). - Placeholders that affect formatting of later placeholders: -'%Cred':: switch color to red -'%Cgreen':: switch color to green -'%Cblue':: switch color to blue -'%Creset':: reset color -'%C(...)':: color specification, as described under Values in the +++%Cred++:: switch color to red +++%Cgreen++:: switch color to green +++%Cblue++:: switch color to blue +++%Creset++:: reset color +++%C(++__++)++:: color specification, as described under Values in the "CONFIGURATION FILE" section of linkgit:git-config[1]. By default, colors are shown only when enabled for log output (by `color.diff`, `color.ui`, or `--color`, and respecting the `auto` settings of the former if we are going to a - terminal). `%C(auto,...)` is accepted as a historical - synonym for the default (e.g., `%C(auto,red)`). Specifying - `%C(always,...)` will show the colors even when color is + terminal). ++%C(auto,++__++)++ is accepted as a historical + synonym for the default (e.g., ++%C(auto,red)++). Specifying + ++%C(always,++__++)++ will show the colors even when color is not otherwise enabled (though consider just using - `--color=always` to enable color for the whole output, + `--color=always` to enable color for the whole output, including this format and anything else git might color). - `auto` alone (i.e. `%C(auto)`) will turn on auto coloring + `auto` alone (i.e. ++%C(auto)++) will turn on auto coloring on the next placeholders until the color is switched again. -'%m':: left (`<`), right (`>`) or boundary (`-`) mark -'%w([[,[,]]])':: switch line wrapping, like the -w option of +++%m++:: left (`<`), right (`>`) or boundary (`-`) mark +++%w(++`[[,[,]]]`++)++:: switch line wrapping, like the `-w` option of linkgit:git-shortlog[1]. -'%<( [,trunc|ltrunc|mtrunc])':: make the next placeholder take at +++%<(++`[,(trunc|ltrunc|mtrunc)]`++)++:: make the next placeholder take at least N column widths, padding spaces on the right if necessary. Optionally - truncate (with ellipsis '..') at the left (ltrunc) `..ft`, + truncate (with ellipsis `..`) at the left (ltrunc) `..ft`, the middle (mtrunc) `mi..le`, or the end (trunc) `rig..`, if the output is longer than - N columns. + __ columns. Note 1: that truncating - only works correctly with N >= 2. - Note 2: spaces around the N and M (see below) + only works correctly with __ >= 2. + Note 2: spaces around the __ and __ (see below) values are optional. Note 3: Emojis and other wide characters will take two display columns, which may over-run column boundaries. Note 4: decomposed character combining marks may be misplaced at padding boundaries. -'%<|( )':: make the next placeholder take at least until Mth +++%<|(++__ ++)++:: make the next placeholder take at least until __ th display column, padding spaces on the right if necessary. - Use negative M values for column positions measured + Use negative __ values for column positions measured from the right hand edge of the terminal window. -'%>( )', '%>|( )':: similar to '%<( )', '%<|( )' respectively, +++%>(++__++)++:: +++%>|(++__++)++:: similar to ++%<(++__++)++, ++%<|(++__++)++ respectively, but padding spaces on the left -'%>>( )', '%>>|( )':: similar to '%>( )', '%>|( )' +++%>>(++__++)++:: +++%>>|(++__++)++:: similar to ++%>(++__++)++, ++%>|(++__++)++ respectively, except that if the next placeholder takes more spaces than given and there are spaces on its left, use those spaces -'%><( )', '%><|( )':: similar to '%<( )', '%<|( )' +++%><(++__++)++:: +++%><|(++__++)++:: similar to ++%<(++__++)++, ++%<|(++__++)++ respectively, but padding both sides (i.e. the text is centered) - Placeholders that expand to information extracted from the commit: -'%H':: commit hash -'%h':: abbreviated commit hash -'%T':: tree hash -'%t':: abbreviated tree hash -'%P':: parent hashes -'%p':: abbreviated parent hashes -'%an':: author name -'%aN':: author name (respecting .mailmap, see linkgit:git-shortlog[1] ++%H+:: commit hash ++%h+:: abbreviated commit hash ++%T+:: tree hash ++%t+:: abbreviated tree hash ++%P+:: parent hashes ++%p+:: abbreviated parent hashes ++%an+:: author name ++%aN+:: author name (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) -'%ae':: author email -'%aE':: author email (respecting .mailmap, see linkgit:git-shortlog[1] ++%ae+:: author email ++%aE+:: author email (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) -'%al':: author email local-part (the part before the '@' sign) -'%aL':: author local-part (see '%al') respecting .mailmap, see ++%al+:: author email local-part (the part before the `@` sign) ++%aL+:: author local-part (see +%al+) respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) -'%ad':: author date (format respects --date= option) -'%aD':: author date, RFC2822 style -'%ar':: author date, relative -'%at':: author date, UNIX timestamp -'%ai':: author date, ISO 8601-like format -'%aI':: author date, strict ISO 8601 format -'%as':: author date, short format (`YYYY-MM-DD`) -'%ah':: author date, human style (like the `--date=human` option of ++%ad+:: author date (format respects --date= option) ++%aD+:: author date, RFC2822 style ++%ar+:: author date, relative ++%at+:: author date, UNIX timestamp ++%ai+:: author date, ISO 8601-like format ++%aI+:: author date, strict ISO 8601 format ++%as+:: author date, short format (`YYYY-MM-DD`) ++%ah+:: author date, human style (like the `--date=human` option of linkgit:git-rev-list[1]) -'%cn':: committer name -'%cN':: committer name (respecting .mailmap, see ++%cn+:: committer name ++%cN+:: committer name (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) -'%ce':: committer email -'%cE':: committer email (respecting .mailmap, see ++%ce+:: committer email ++%cE+:: committer email (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) -'%cl':: committer email local-part (the part before the '@' sign) -'%cL':: committer local-part (see '%cl') respecting .mailmap, see ++%cl+:: committer email local-part (the part before the `@` sign) ++%cL+:: committer local-part (see +%cl+) respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) -'%cd':: committer date (format respects --date= option) -'%cD':: committer date, RFC2822 style -'%cr':: committer date, relative -'%ct':: committer date, UNIX timestamp -'%ci':: committer date, ISO 8601-like format -'%cI':: committer date, strict ISO 8601 format -'%cs':: committer date, short format (`YYYY-MM-DD`) -'%ch':: committer date, human style (like the `--date=human` option of ++%cd+:: committer date (format respects --date= option) ++%cD+:: committer date, RFC2822 style ++%cr+:: committer date, relative ++%ct+:: committer date, UNIX timestamp ++%ci+:: committer date, ISO 8601-like format ++%cI+:: committer date, strict ISO 8601 format ++%cs+:: committer date, short format (`YYYY-MM-DD`) ++%ch+:: committer date, human style (like the `--date=human` option of linkgit:git-rev-list[1]) -'%d':: ref names, like the --decorate option of linkgit:git-log[1] -'%D':: ref names without the " (", ")" wrapping. -'%(decorate[:])':: ++%d+:: ref names, like the --decorate option of linkgit:git-log[1] ++%D+:: ref names without the " (", ")" wrapping. +++%(decorate++`[: