git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: jaydeepjd.8914@gmail.com
To: Junio C Hamano <gitster@pobox.com>,
	Bagas Sanjaya <bagasdotme@gmail.com>,
	git@vger.kernel.org
Subject: Re: [PATCH] t/t0015-hash.sh: removed unnecessary '\' at line end
Date: Thu, 10 Feb 2022 12:41:55 +0530	[thread overview]
Message-ID: <bc36eab7-62ae-2e67-aa4f-cceec5c86012@gmail.com> (raw)
In-Reply-To: <xmqq4k57xlot.fsf@gitster.g>

Thanks for the quick response.

> > I have a few more questions regarding contributions.
> > I have seen that some command documentations lack consistent synopsis compared to other commands.
> > Is it on purpose or are improvements to those documentations welcome ?
> 
> That's hard to answer, as what you perceive as "lack consistent" may
> or may not be consistent from other people's perspective, without a
> concrete "here is the comparison I am talking about, and this makes
> the two comparable" patch.


Here is an example. The synopsis of command `send-email` vs synopsis of `commit`:

```
git send-email [<options>] <file|directory>…​
git send-email [<options>] <format-patch options>
git send-email --dump-aliases
```

```
git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]
	   [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>)]
	   [-F <file> | -m <msg>] [--reset-author] [--allow-empty]
	   [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
	   [--date=<date>] [--cleanup=<mode>] [--[no-]status]
	   [-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]
	   [(--trailer <token>[(=|:)<value>])…​] [-S[<keyid>]]
	   [--] [<pathspec>…​]
```

The `commit` synopsis has a more verbose overview of all the options available compared to `send-email` synopsis.

  reply	other threads:[~2022-02-10  7:12 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-02-08  9:23 [PATCH] t/t0015-hash.sh: removed unnecessary '\' at line end Jaydeep P Das
2022-02-08  9:23 ` Jaydeep P Das
2022-02-10  1:18   ` Bagas Sanjaya
2022-02-10  1:42     ` Junio C Hamano
2022-02-10  5:52       ` jaydeepjd.8914
2022-02-10  6:47         ` Junio C Hamano
2022-02-10  7:11           ` jaydeepjd.8914 [this message]
2022-02-10 17:20             ` Junio C Hamano

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=bc36eab7-62ae-2e67-aa4f-cceec5c86012@gmail.com \
    --to=jaydeepjd.8914@gmail.com \
    --cc=bagasdotme@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.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).