git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Johannes Altmanninger <aclopte@gmail.com>
Cc: newren@gmail.com, git@vger.kernel.org
Subject: Re: [PATCH v2 4/4] Documentation/git-status: mention how to detect copies
Date: Wed, 6 Oct 2021 12:05:02 +0700	[thread overview]
Message-ID: <88adcdf1-7b10-c834-84ad-52fe273c0ced@gmail.com> (raw)
In-Reply-To: <20211005194224.qcblxih5rlehzo4d@gmail.com>

On 06/10/21 02.42, Johannes Altmanninger wrote:
> I wasn't sure whether to add backticks to status.renames because we are
> already inconsistent in this file (search for "config option").
> Anyway I agree that backticks look better here (makes it bold in the man page).
> 
> Maybe we should automate this? We can write a test that makes sure that we
> always use backticks around config keys, at least for new changes.
> 
> ---
> 
> I didn't add backticks to "copies" to be consistent with this part before the context
> 
> 	Ignore changes to submodules when looking for changes. <when> can be
> 	either "none", "untracked", "dirty" or "all", which is the default.
> 

I think for consistency, we can go with automated style changes that use 
backticks to monospace:
     - file name and paths
     - daemons/services
     - configuration names and values
     - file content (use ```...``` block unless inline)
     - command-line
     - keyboard keys (dunno?)
     - any other inline text that needs to be written exactly

I have seen many times articles that say `Run "foo bar" (no quotes)` 
when they mean `Run `foo bar``.

For the exception you mentioned above it can be monospaced as part of 
automated change above.

-- 
An old man doll... just what I always wanted! - Clara

  reply	other threads:[~2021-10-06  5:05 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-02 21:30 [PATCH 1/2] Documentation/diff-format: state in which cases porcelain status is T Johannes Altmanninger
2021-10-02 21:30 ` [PATCH 2/2] Documentation/git-status: document porcelain status T (typechange) Johannes Altmanninger
2021-10-02 21:33   ` Johannes Altmanninger
2021-10-02 23:29   ` Elijah Newren
2021-10-04 18:57     ` Johannes Altmanninger
2021-10-04 19:00     ` [PATCH v2 1/4] Documentation/git-status: remove impossible porcelain status DR and DC Johannes Altmanninger
2021-10-04 19:00       ` [PATCH v2 2/4] Documentation/diff-format: state in which cases porcelain status is T Johannes Altmanninger
2021-10-04 19:00       ` [PATCH v2 3/4] Documentation/git-status: document porcelain status T (typechange) Johannes Altmanninger
2021-10-04 19:00       ` [PATCH v2 4/4] Documentation/git-status: mention how to detect copies Johannes Altmanninger
2021-10-05  9:48         ` Bagas Sanjaya
2021-10-05 19:42           ` Johannes Altmanninger
2021-10-06  5:05             ` Bagas Sanjaya [this message]
2021-10-06  6:04               ` Elijah Newren
2021-10-04 20:02       ` [PATCH v2 1/4] Documentation/git-status: remove impossible porcelain status DR and DC Junio C Hamano
2021-10-04 20:12         ` Junio C Hamano
2021-10-02 23:35 ` [PATCH 1/2] Documentation/diff-format: state in which cases porcelain status is T Elijah Newren

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=88adcdf1-7b10-c834-84ad-52fe273c0ced@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=aclopte@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=newren@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).