* [PATCH] git-send-email.txt: Add EXAMPLES section. Write 1st level sections in uppercase @ 2010-04-15 15:37 jari.aalto 2010-04-16 8:01 ` Michael J Gruber 0 siblings, 1 reply; 6+ messages in thread From: jari.aalto @ 2010-04-15 15:37 UTC (permalink / raw) To: git; +Cc: Jari Aalto From: Jari Aalto <jari.aalto@cante.net> Signed-off-by: Jari Aalto <jari.aalto@cante.net> --- Documentation/git-send-email.txt | 36 ++++++++++++++++++++++++++++++++++-- 1 files changed, 34 insertions(+), 2 deletions(-) diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt index ced35b2..8b33eb0 100644 --- a/Documentation/git-send-email.txt +++ b/Documentation/git-send-email.txt @@ -299,8 +299,40 @@ sendemail.confirm:: one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm' in the previous section for the meaning of these values. +EXAMPLES +-------- -Author +To batch send all patches to a mailig list, no copies to oneself, +messages in a relaxed single thread format (no nesting) and don't ask +any confirmations: + + git send-email \ + --from $EMAIL \ + --to address@list.example.com \ + --suppress-cc=author \ + --suppress-from \ + --no-chain-reply-to \ + --confirm=never \ + outgoing/ + +Tip: in case the patches in a branch need rework, you might consider +adjusting the subjects of each patch to "[PATCH v<number>]" with +options '--subject-prefix'. The 'merge-base' inside command +substitution is there to find out the initial commit of the branch: + + git checkout BRANCH + + git format-patch \ + --subject-prefix="PATCH v2" \ + --signoff \ + -M \ + --output-directory outgoing/ + $(git merge-base HEAD master).. + +Then proceed as in in the first example the send the patches out +again. + +AUTHOR ------ Written by Ryan Anderson <ryan@michonline.com> @@ -308,7 +340,7 @@ git-send-email is originally based upon send_lots_of_email.pl by Greg Kroah-Hartman. -Documentation +DOCUMENTATION -------------- Documentation by Ryan Anderson -- 1.7.0 ^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH] git-send-email.txt: Add EXAMPLES section. Write 1st level sections in uppercase 2010-04-15 15:37 [PATCH] git-send-email.txt: Add EXAMPLES section. Write 1st level sections in uppercase jari.aalto @ 2010-04-16 8:01 ` Michael J Gruber 2010-04-16 11:46 ` Jari Aalto 0 siblings, 1 reply; 6+ messages in thread From: Michael J Gruber @ 2010-04-16 8:01 UTC (permalink / raw) To: jari.aalto; +Cc: git jari.aalto@cante.net venit, vidit, dixit 15.04.2010 17:37: > From: Jari Aalto <jari.aalto@cante.net> > > > Signed-off-by: Jari Aalto <jari.aalto@cante.net> > --- > Documentation/git-send-email.txt | 36 ++++++++++++++++++++++++++++++++++-- > 1 files changed, 34 insertions(+), 2 deletions(-) > > diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt > index ced35b2..8b33eb0 100644 > --- a/Documentation/git-send-email.txt > +++ b/Documentation/git-send-email.txt > @@ -299,8 +299,40 @@ sendemail.confirm:: > one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm' > in the previous section for the meaning of these values. > > +EXAMPLES > +-------- > > -Author > +To batch send all patches to a mailig list, no copies to oneself, > +messages in a relaxed single thread format (no nesting) and don't ask > +any confirmations: That sentence is linguistically screwed, but... > + > + git send-email \ > + --from $EMAIL \ > + --to address@list.example.com \ > + --suppress-cc=author \ > + --suppress-from \ > + --no-chain-reply-to \ > + --confirm=never \ > + outgoing/ > + ... I don't think this is a good example at all. All options are explained in the man page, so what is the point in listing and explaining some of them here? If we really want an introductory example, we want one with few options, where the default behaviour is explained. > +Tip: in case the patches in a branch need rework, you might consider > +adjusting the subjects of each patch to "[PATCH v<number>]" with > +options '--subject-prefix'. That is a git.git convention, and it applies to format-patch, not send-email. > The 'merge-base' inside command > +substitution is there to find out the initial commit of the branch: > + > + git checkout BRANCH > + > + git format-patch \ > + --subject-prefix="PATCH v2" \ > + --signoff \ > + -M \ > + --output-directory outgoing/ > + $(git merge-base HEAD master).. > + This is a useful example (although it mixes several issues), but one for format-patch, not send-email. You assume you branched off master. Using @{upstream} might be a more general option. > +Then proceed as in in the first example the send the patches out > +again. > + > +AUTHOR > ------ > Written by Ryan Anderson <ryan@michonline.com> > > @@ -308,7 +340,7 @@ git-send-email is originally based upon > send_lots_of_email.pl by Greg Kroah-Hartman. > > > -Documentation > +DOCUMENTATION > -------------- > Documentation by Ryan Anderson > ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] git-send-email.txt: Add EXAMPLES section. Write 1st level sections in uppercase 2010-04-16 8:01 ` Michael J Gruber @ 2010-04-16 11:46 ` Jari Aalto 2010-04-16 13:04 ` Michael J Gruber 0 siblings, 1 reply; 6+ messages in thread From: Jari Aalto @ 2010-04-16 11:46 UTC (permalink / raw) To: Michael J Gruber; +Cc: git Michael J Gruber <git@drmicha.warpmail.net> writes: > jari.aalto@cante.net venit, vidit, dixit 15.04.2010 17:37: > >> From: Jari Aalto <jari.aalto@cante.net> >> >> >> Signed-off-by: Jari Aalto <jari.aalto@cante.net> >> --- >> Documentation/git-send-email.txt | 36 ++++++++++++++++++++++++++++++++++-- >> 1 files changed, 34 insertions(+), 2 deletions(-) >> >> diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt >> index ced35b2..8b33eb0 100644 >> --- a/Documentation/git-send-email.txt >> +++ b/Documentation/git-send-email.txt >> @@ -299,8 +299,40 @@ sendemail.confirm:: >> one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm' >> in the previous section for the meaning of these values. >> >> +EXAMPLES >> +-------- >> >> -Author >> +To batch send all patches to a mailig list, no copies to oneself, >> +messages in a relaxed single thread format (no nesting) and don't ask >> +any confirmations: > > That sentence is linguistically screwed, but... Please improve. How would you explain the options and their explanations one-by-one as presented below? >> + >> + git send-email \ >> + --from $EMAIL \ >> + --to address@list.example.com \ >> + --suppress-cc=author \ >> + --suppress-from \ >> + --no-chain-reply-to \ >> + --confirm=never \ >> + outgoing/ >> + > > ... I don't think this is a good example at all. All options are > explained in the man page, so what is the point in listing and > explaining some of them here? Right, all the 31 options. > If we really want an introductory example, > we want one with few options, where the default behaviour is explained. I don't agree. We need examples that use most of the options in combination so that the examples can practically "copy pasted / sliced off". The user can eaily reduce options he may not find useful from the examples. With too few options presented, he needs to skim through the whole of 31 option explanations above and pray he finds what he needs. Please suggest another example to be accompanied with this one. How do you use the git-send-email? What options? What you have configured in ~/.gitconfig? Jari ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] git-send-email.txt: Add EXAMPLES section. Write 1st level sections in uppercase 2010-04-16 11:46 ` Jari Aalto @ 2010-04-16 13:04 ` Michael J Gruber 2010-04-16 17:05 ` Jari Aalto 2010-04-17 18:46 ` Junio C Hamano 0 siblings, 2 replies; 6+ messages in thread From: Michael J Gruber @ 2010-04-16 13:04 UTC (permalink / raw) To: Jari Aalto; +Cc: git Jari Aalto venit, vidit, dixit 16.04.2010 13:46: > Michael J Gruber <git@drmicha.warpmail.net> writes: > >> jari.aalto@cante.net venit, vidit, dixit 15.04.2010 17:37: >> >>> From: Jari Aalto <jari.aalto@cante.net> >>> >>> >>> Signed-off-by: Jari Aalto <jari.aalto@cante.net> >>> --- >>> Documentation/git-send-email.txt | 36 ++++++++++++++++++++++++++++++++++-- >>> 1 files changed, 34 insertions(+), 2 deletions(-) >>> >>> diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt >>> index ced35b2..8b33eb0 100644 >>> --- a/Documentation/git-send-email.txt >>> +++ b/Documentation/git-send-email.txt >>> @@ -299,8 +299,40 @@ sendemail.confirm:: >>> one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm' >>> in the previous section for the meaning of these values. >>> >>> +EXAMPLES >>> +-------- >>> >>> -Author >>> +To batch send all patches to a mailig list, no copies to oneself, >>> +messages in a relaxed single thread format (no nesting) and don't ask >>> +any confirmations: >> >> That sentence is linguistically screwed, but... > > Please improve. How would you explain the options and their explanations > one-by-one as presented below? By "but..." and the paragraph below I meant to say that there is no need to pick on individual typos and such, because I don't favour the approach anyways. Looking at the send-email man page, I definitely agree with you that there is room for improvement. For example, in the end there is a configuration section listing only very few of the config options. The reader could easily think these are the only ones. We tend to list them in git-config's man page, which one may or may not like... > >>> + >>> + git send-email \ >>> + --from $EMAIL \ >>> + --to address@list.example.com \ >>> + --suppress-cc=author \ >>> + --suppress-from \ >>> + --no-chain-reply-to \ >>> + --confirm=never \ >>> + outgoing/ >>> + >> >> ... I don't think this is a good example at all. All options are >> explained in the man page, so what is the point in listing and >> explaining some of them here? > > Right, all the 31 options. > >> If we really want an introductory example, >> we want one with few options, where the default behaviour is explained. > > I don't agree. > > We need examples that use most of the options in combination so that the > examples can practically "copy pasted / sliced off". The user can eaily > reduce options he may not find useful from the examples. > > With too few options presented, he needs to skim through the whole > of 31 option explanations above and pray he finds what he needs. > > Please suggest another example to be accompanied with this one. How do > you use the git-send-email? What options? What you have configured in > ~/.gitconfig? I don't use any options besides --dry-run and --cc, which is the point of the config options ;) In config I have to, smtpserver (pointing to an msmtp-script), bcc, suppresscc, aliasesfile, aliastype, but that depends on the project, of course (git.git here). I just think that using all these options on the command line is very atypical. It would be helpful to see the defaults in one place: "Without any options, send-email will send patches (using /usr/sbin/sendmail or /usr/lib/sendmail or localhost) using any from, cc and subject lines contained in the patch files; you have to specify at least --to, or else you will be prompted for it. All defaults pertaining to composing and sending of the patch mails and to automating this process can be changed with config options, see the corresponding sections below." I liked your format-patch example with merge-base, I just liked it better in format-patch's man page ;) Michael ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] git-send-email.txt: Add EXAMPLES section. Write 1st level sections in uppercase 2010-04-16 13:04 ` Michael J Gruber @ 2010-04-16 17:05 ` Jari Aalto 2010-04-17 18:46 ` Junio C Hamano 1 sibling, 0 replies; 6+ messages in thread From: Jari Aalto @ 2010-04-16 17:05 UTC (permalink / raw) To: Michael J Gruber; +Cc: git Michael J Gruber <git@drmicha.warpmail.net> writes: > I just think that using all these options on the command line is very > atypical. It would be helpful to see the defaults in one place: Now, think this: You have 30 servers. You notice a problem. You need that command, whatever that is. Consult manual page, yay (Wow, or "Ugh") <blink> there is EXMAPLE, options and - Hurray: Copy/Paste and use. You don't necessarily have full blown "environment" in front of you, so we need both * Full command line exmaples. They are commadn line options after all * And configuration examples The more copy/paste ready, the better. The more FAQ like, the better. Let's make FAQs obsolete. Thansk for the examples, I'll be revising the patch Jari ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] git-send-email.txt: Add EXAMPLES section. Write 1st level sections in uppercase 2010-04-16 13:04 ` Michael J Gruber 2010-04-16 17:05 ` Jari Aalto @ 2010-04-17 18:46 ` Junio C Hamano 1 sibling, 0 replies; 6+ messages in thread From: Junio C Hamano @ 2010-04-17 18:46 UTC (permalink / raw) To: Michael J Gruber; +Cc: Jari Aalto, git Michael J Gruber <git@drmicha.warpmail.net> writes: > I don't use any options besides --dry-run and --cc, which is the point > of the config options ;) In config I have to, smtpserver (pointing to an > msmtp-script), bcc, suppresscc, aliasesfile, aliastype, but that depends > on the project, of course (git.git here). > > I just think that using all these options on the command line is very > atypical. Having to give too many options from the command line all the time is a sure sign that the defaults for unconfigured case are bad (which may well be true but is is hard to change without a good plan) and that it is not clearly explained how to configure the defaults for the repository. I do not think it is productive to give an overwhelming list that you would rarely use (i.e. until you figure out a good set of defaults for the project). > "Without any options, send-email will send patches (using > /usr/sbin/sendmail or /usr/lib/sendmail or localhost) using any from, cc > and subject lines contained in the patch files; you have to specify at > least --to, or else you will be prompted for it. > > All defaults pertaining to composing and sending of the patch mails and > to automating this process can be changed with config options, see the > corresponding sections below." Yes, I think we should proceed in this direction. > I liked your format-patch example with merge-base, I just liked it > better in format-patch's man page ;) Likewise. ^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2010-04-17 18:46 UTC | newest] Thread overview: 6+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2010-04-15 15:37 [PATCH] git-send-email.txt: Add EXAMPLES section. Write 1st level sections in uppercase jari.aalto 2010-04-16 8:01 ` Michael J Gruber 2010-04-16 11:46 ` Jari Aalto 2010-04-16 13:04 ` Michael J Gruber 2010-04-16 17:05 ` Jari Aalto 2010-04-17 18:46 ` Junio C Hamano
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 NNTP newsgroup(s).