summaryrefslogtreecommitdiff
path: root/Documentation/SubmittingPatches
Commit message (Collapse)AuthorAgeFilesLines
* Merge branch 'rs/doc-submitting-patches'Junio C Hamano2013-12-121-2/+9
|\ | | | | | | | | * rs/doc-submitting-patches: SubmittingPatches: document how to handle multiple patches
| * SubmittingPatches: document how to handle multiple patchesrs/doc-submitting-patchesRené Scharfe2013-11-271-2/+9
| | | | | | | | | | Signed-off-by: Rene Scharfe <l.s.r@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Provide some linguistic guidance for the documentation.mb/docs-favor-en-usMarc Branchaud2013-08-011-1/+14
|/ | | | | | | | | This will hopefully avoid questions over which spelling and grammar should be used. Translators are of course free to create localizations for specific English dialects. Signed-off-by: Marc Branchaud <marcnarc@xiplink.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: the name of the system is 'Git', not 'git'Thomas Ackermann2013-02-011-5/+5
| | | | | Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: avoid poor-man's small caps GITThomas Ackermann2013-02-011-1/+1
| | | | | | | | | | | | | | In the earlier days, we used to spell the name of the system as GIT, to simulate as if it were typeset with capital G and IT in small caps. Later we stopped doing so at around 1.6.5 days. Let's stop doing so throughout the documentation. The name to refer to the whole system (and the concept it embodies) is "Git"; the command end-users type is "git". And document this in the coding guideline. Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Merge branch 'jc/submittingpatches'Junio C Hamano2013-01-091-84/+91
|\ | | | | | | | | | | | | | | | | | | | | Streamline the document and update with a few e-mail addresses the patches should be sent to. * jc/submittingpatches: SubmittingPatches: give list and maintainer addresses SubmittingPatches: remove overlong checklist SubmittingPatches: mention subsystems with dedicated repositories SubmittingPatches: who am I and who cares?
| * SubmittingPatches: give list and maintainer addressesJunio C Hamano2013-01-021-2/+6
| | | | | | | | | | | | | | We told readers to "send it to the list" (or the maintainer) without telling what addresses are to be used. Correct this. Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * SubmittingPatches: remove overlong checklistJunio C Hamano2013-01-021-76/+61
| | | | | | | | | | | | | | | | | | | | | | The section is no longer a concise checklist. It also talks about things that are not covered in the "Long version" text, which means people need to read both, covering more or less the same thing in different phrasing. Fold the details into the main text and remove the section. Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * SubmittingPatches: mention subsystems with dedicated repositoriesJunio C Hamano2013-01-011-0/+24
| | | | | | | | | | | | | | | | | | These were only mentioned in periodical "A note from the maintainer" posting and not in the documentation suite. SubmittingPatches has a section to help contributors decide on what commit to base their changes, which is the most suitable place for this information. Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * SubmittingPatches: who am I and who cares?Junio C Hamano2013-01-011-8/+2
| | | | | | | | | | | | | | | | | | | | | | The introductory text in the "long version" talks about the origin of this document with "I started ...", but it is unclear who that I is, and more importantly, it is not interesting how it was started. Just state the purpose of the document to help readers decide if it is releavant to them. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Merge branch 'as/doc-for-devs'Junio C Hamano2012-12-211-13/+8
|\ \ | |/ | | | | | | | | | | | | | | It might be a better idea to move the text the bottom one adds to the extended description from the quick checklist part. * as/doc-for-devs: Documentation: move support for old compilers to CodingGuidelines SubmittingPatches: add convention of prefixing commit messages
| * Documentation: move support for old compilers to CodingGuidelinesAdam Spiers2012-12-161-13/+0
| | | | | | | | | | | | | | | | The "Try to be nice to older C compilers" text is clearly a guideline to be borne in mind whilst coding rather than when submitting patches. Signed-off-by: Adam Spiers <git@adamspiers.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * SubmittingPatches: add convention of prefixing commit messagesAdam Spiers2012-12-161-0/+8
| | | | | | | | | | | | | | | | | | | | Conscientious newcomers to git development will read SubmittingPatches and CodingGuidelines, but could easily miss the convention of prefixing commit messages with a single word identifying the file or area the commit touches. Signed-off-by: Adam Spiers <git@adamspiers.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Doc SubmittingPatches: Mention --notes option after "cover letter"Philip Oakley2012-10-251-1/+2
|/ | | | | | | | | The git format-patch --notes option can now insert the commit notes after the three dashes. Mention this after the regular cover letter guidance for submitting patches. Signed-off-by: Philip Oakley <philipoakley@iee.org> Signed-off-by: Jeff King <peff@peff.net>
* SubmittingPathces: remove Cogito referenceSverre Rabbelier2011-09-111-2/+1
| | | | | | | | | Removing Cogito leaves just git and StGit, which is a rather incomplete list of git diff tools available. Sidestep the problem of deciding what tools to mention by not mentioning any. Signed-off-by: Sverre Rabbelier <srabbelier@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: publicize hints for sending patches with GMailJonathan Nieder2011-04-151-52/+2
| | | | | | | | | | | | | The hints in SubmittingPatches about stopping GMail from clobbering patches are widely useful both as examples of "git send-email" and "git imap-send" usage. Move the documentation to the appropriate places. While at it, don't encourage storing passwords in config files. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: publicize KMail hints for sending patches inlineJonathan Nieder2011-04-151-20/+2
| | | | | | | | | | | | These hints are in git's private SubmittingPatches document but a wider audience might be interested. Move them to the "git format-patch" manpage. I'm not sure what gotchas these hints are meant to work around. They might be completely false. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: hints for sending patches inline with ThunderbirdJonathan Nieder2011-04-151-80/+1
| | | | | | | | | | | | | | | | | | | The standard reference for this information is the article "Plain text e-mail - Thunderbird#Completely_plain_email" at kb.mozillazine.org, but the hints hidden away in git's SubmittingPatches file are more complete. Move them to the "git format-patch" manual so they can be installed with git and read by a wide audience. While at it, make some tweaks: - update "Approach #1" so it might work with Thunderbird 3; - remove ancient version numbers from the descriptions of both approaches so current readers might have more reason to complain if they don't work. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: explain how to check for patch corruptionJonathan Nieder2011-04-151-44/+14
| | | | | | | | | | SubmittingPatches has some excellent advice about how to check a patch for corruption before sending it off. Move it to the format-patch manual so it can be installed with git's documentation for use by people not necessarily interested in the git project's practices. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* remove doubled words, e.g., s/to to/to/, and fix related typosJim Meyering2011-04-131-2/+1
| | | | | | | | | | | | | | | | I found that some doubled words had snuck back into projects from which I'd already removed them, so now there's a "syntax-check" makefile rule in gnulib to help prevent recurrence. Running the command below spotted a few in git, too: git ls-files | xargs perl -0777 -n \ -e 'while (/\b(then?|[iao]n|i[fst]|but|f?or|at|and|[dt])\s+\1\b/gims)' \ -e '{$n=($` =~ tr/\n/\n/ + 1); ($v=$&)=~s/\n/\\n/g;' \ -e 'print "$ARGV:$n:$v\n"}' Signed-off-by: Jim Meyering <meyering@redhat.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* SubmittingPatches: clarify the expected commit log descriptionJunio C Hamano2011-03-081-8/+18
| | | | | | | | | | | | Earlier, 47afed5 (SubmittingPatches: itemize and reflect upon well written changes, 2009-04-28) added a discussion on the contents of the commit log message, but the last part of the new paragraph didn't make much sense. Reword it slightly to make it more readable. Update the "quicklist" to clarify what we mean by "motivation" and "contrast". Also mildly discourage external references. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* SubmittingPatches: Document some extra tags used in commit messagesRamkumar Ramachandra2010-10-061-6/+15
| | | | | | | | | | | Document the meanings of the tags "Reported-by:", "Acked-by:", "Reviewed-by:" and "Tested-by:" clearly. Also mention that the user is free to use any custom tags. Helped-by: Jonathan Nieder <jrnieder@gmail.com> Liked-by: Sverre Rabbelier <srabbelier@gmail.com> Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* SubmittingPatches: Cite the 50 char subject limitÆvar Arnfjörð Bjarmason2010-07-281-1/+2
| | | | | | | | | | | Change the SubmittingPatches recommendations to mention the 50 character soft limit on patch subject lines. 50 characters is the soft limit mentioned in git-commit(1) and gittutorial(7), it's also the point at which Gitweb, GitHub and various other Git front ends start abbreviating the commit message. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* SubmittingPatches: Clarify the Signed-off-by rulesÆvar Arnfjörð Bjarmason2010-07-281-5/+3
| | | | | | | | | | | | | | | | | | | | | | The wording of the Signed-off-by rules could be read as stating that S-O-B should only be added when the submitter considered the patch ready for inclusion in git.git. We also want Signed-off-by to be used for e.g. RFC patches, in case someone wants to dig an old patch out of the archive and improve it. Change the wording to recommend a Signed-off-by for all submitted patches. The problem with the wording came up in the "[PATCH/RFC] Hacky version of a glob() driven config include" thread[1]. Bert Wesarg suggested[2] that it be removed to avoid confusion, which this change implements. 1. <1273180440-8641-1-git-send-email-avarab@gmail.com> 2. <AANLkTimziTKL13VKIOcaS1TX1F_xvTVjH8Q398Yx36Us@mail.gmail.com> Suggested-by: Bert Wesarg <bert.wesarg@googlemail.com> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Merge branch 'maint'Junio C Hamano2010-05-311-1/+1
|\ | | | | | | | | | | * maint: Documentation/SubmittingPatches: Fix typo in GMail section Documentation/config: describe status.submodulesummary
| * Documentation/SubmittingPatches: Fix typo in GMail sectionTim Henigan2010-05-311-1/+1
| | | | | | | | | | | | | | | | | | Commit e498257d introduced a typo while improving the GMail section of SubmittingPatches. Signed-off-by: Tim Henigan <tim.henigan@gmail.com> Acked-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Merge branch 'maint'Junio C Hamano2010-05-251-19/+21
|\ \ | |/ | | | | | | | | | | | | * maint: Documentation/SubmittingPatches: clarify GMail section and SMTP show-branch: use DEFAULT_ABBREV instead of 7 t7502-commit: fix spelling test get_git_work_tree() return value for NULL
| * Documentation/SubmittingPatches: clarify GMail section and SMTPMichael J Gruber2010-05-251-19/+21
| | | | | | | | | | | | | | | | | | | | | | | | We keep getting mangled submissions from GMail's web interface. Try to be more proactive in SubmittingPatches by - pointing to MUA specific instructions early on, - structuring the GMail section more clearly, - putting send-email/SMTP before imap-send/IMAP. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Merge branch 'rr/doc-submitting'Junio C Hamano2010-05-211-11/+38
|\ \ | |/ |/| | | | | * rr/doc-submitting: SubmittingPatches: Add new section about what to base work on
| * SubmittingPatches: Add new section about what to base work onRamkumar Ramachandra2010-04-181-11/+38
| | | | | | | | | | | | | | Add a section 0 explaining which commit to base patches on. Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | SubmittingPatches: update GMail sectionJunio C Hamano2010-04-071-11/+24
|/ | | | | | | | | | | | | | Even if you use imap-send to throw your drafts in the outbox, using their web interface will mangle your patches. Clarify that the imap-send is meant to be used together with a real MUA that can use IMAP drafts, and remove instructions related to the web interface, which is irrelevant. Add description of send-email as an alternative. Use --cover-letter, and do not use -C nor --no-color, on the example command line for format-patch. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* SubmittingPatches: hints to know the status of a submitted patch.Matthieu Moy2009-12-311-0/+14
| | | | | | | | "What happened to my patch" is pretty much a FAQ on the Git mailing list, it deserves a few paragraphs in SubmittingPatches... Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* SubmittingPatches: itemize and reflect upon well written changesSam Vilain2009-04-281-1/+13
| | | | | | | | | | The SubmittingPatches file was trimmed down from a somewhat overwhelming set of requirements from the Linux Kernel equivalent; however perhaps a little of it can be returned without making the text too long. Signed-off-by: Sam Vilain <sam@vilain.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Google has renamed the imap folderJohn Tapsell2009-03-041-0/+10
| | | | | | | Also add a comment that the web interface wraps the lines Signed-off-by: John Tapsell <johnflux@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Update documentation to add further information about using Thunderbird with ↵Jeremy White2009-02-121-0/+27
| | | | | | | git-imap-send. Signed-off-by: Jeremy White <jwhite@codeweavers.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Merge branch 'maint' to sync with GIT 1.6.0.6Junio C Hamano2008-12-191-0/+3
|\ | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * SubmittingPatches: mention the usage of real name in Signed-off-by: linesMiklos Vajna2008-12-191-0/+3
| | | | | | | | | | | | | | | | | | | | Especially with something that is supposed to hopefully have some legal value down the line if somebody starts making noises, it really would be nice to have a real person to associate things with. Suggest this in the SubmittingPatches document. Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Merge branch 'maint'Junio C Hamano2008-11-021-0/+27
|\ \ | |/ | | | | | | | | | | | | | | | | | | | | | | | | | | * maint: Start 1.6.0.4 cycle add instructions on how to send patches to the mailing list with Gmail Documentation/gitattributes: Add subsection header for each attribute git send-email: avoid leaking directory file descriptors. send-pack: do not send out single-level refs such as refs/stash fix overlapping memcpy in normalize_absolute_path pack-objects: avoid reading uninitalized data correct cache_entry allocation Conflicts: RelNotes
| * add instructions on how to send patches to the mailing list with GmailTom Preston-Werner2008-11-011-0/+27
| | | | | | | | | | | | | | | | | | Gmail is one of the most popular email providers in the world. Now that Gmail supports IMAP, sending properly formatted patches via `git imap-send` is trivial. This section in SubmittingPatches explains how to do so. Signed-off-by: Tom Preston-Werner <tom@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | SubmittingPatches: fix a typoJim Meyering2008-08-191-1/+1
|/ | | | | Signed-off-by: Jim Meyering <meyering@redhat.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Rename .git/rebase to .git/rebase-applyJohannes Schindelin2008-07-211-1/+1
| | | | | | | | | | With git-am, it sounds awkward to have the patches in ".git/rebase/", but for technical reasons, we have to keep the same directory name for git-am and git-rebase. ".git/rebase-apply" seems to be a good compromise. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Rename ".dotest/" to ".git/rebase" and ".dotest-merge" to "rebase-merge"Johannes Schindelin2008-07-151-1/+1
| | | | | | | | | | | Since the files generated and used during a rebase are never to be tracked, they should live in $GIT_DIR. While at it, avoid the rather meaningless term "dotest" to "rebase", and unhide ".dotest-merge". This was wished for on the mailing list, but so far unimplemented. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Add a helper script to send patches with Mozilla ThunderbirdLukas Sandström2008-06-191-0/+5
| | | | | | | | | The script appp.sh can be used with the External Editor extension for Mozilla Thunderbird in order to be able to send inline patches in an easy way. Signed-off-by: Lukas Sandström <lukass@etek.chalmers.se> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/SubmittingPatches - a suggested patch flowJunio C Hamano2008-02-161-0/+35
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/SubmittingPatches: What's Acked-by and Tested-by?Junio C Hamano2008-02-051-4/+12
| | | | | | | | | We used to talk about "internal company procedures", but this document is about submitting patches to the git mailing list. More useful information is when to say Acked-by: and Tested-by:. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/SubmittingPatches: discuss first then submitJunio C Hamano2008-02-051-4/+5
| | | | | | | | | This is something I've had in mind for some time. I get enough e-mails as-is, and I suspect the workflow to get list members involved would work better if we get the discussion concluded on the list first before patches hit my tree (even 'next'). Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/SubmittingPatches: Instruct how to use [PATCH] Subject headerJunio C Hamano2008-02-051-1/+6
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Change from using email.com to example.com as example domain, as per RFC 2606.David Symonds2007-12-061-1/+1
| | | | | Signed-off-by: David Symonds <dsymonds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* SubmittingPatches: improve the 'Patch:' section of the checklistSergei Organov2007-11-081-5/+4
| | | | | | | | | There were 2 items "send patch to..." but having different set of addresses to send patch to. Merge them together and move the resulting item to the end of checklist. Signed-off-by: Sergei Organov <osv@javad.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Update my contact address as the maintainer.Junio C Hamano2007-09-011-1/+2
|
View Lorry Controller Status