summaryrefslogtreecommitdiff
path: root/Documentation/SubmittingPatches
AgeCommit message (Collapse)AuthorFilesLines
2010-07-28SubmittingPatches: Cite the 50 char subject limitLibravatar Ævar Arnfjörð Bjarmason1-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>
2010-07-28SubmittingPatches: Clarify the Signed-off-by rulesLibravatar Ævar Arnfjörð Bjarmason1-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>
2010-05-31Merge branch 'maint'Libravatar Junio C Hamano1-1/+1
* maint: Documentation/SubmittingPatches: Fix typo in GMail section Documentation/config: describe status.submodulesummary
2010-05-31Documentation/SubmittingPatches: Fix typo in GMail sectionLibravatar Tim Henigan1-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>
2010-05-25Merge branch 'maint'Libravatar Junio C Hamano1-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
2010-05-25Documentation/SubmittingPatches: clarify GMail section and SMTPLibravatar Michael J Gruber1-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>
2010-05-21Merge branch 'rr/doc-submitting'Libravatar Junio C Hamano1-11/+38
* rr/doc-submitting: SubmittingPatches: Add new section about what to base work on
2010-04-18SubmittingPatches: Add new section about what to base work onLibravatar Ramkumar Ramachandra1-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>
2010-04-07SubmittingPatches: update GMail sectionLibravatar Junio C Hamano1-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>
2009-12-31SubmittingPatches: hints to know the status of a submitted patch.Libravatar Matthieu Moy1-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>
2009-04-28SubmittingPatches: itemize and reflect upon well written changesLibravatar Sam Vilain1-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>
2009-03-04Google has renamed the imap folderLibravatar John Tapsell1-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>
2009-02-12Update documentation to add further information about using Thunderbird with ↵Libravatar Jeremy White1-0/+27
git-imap-send. Signed-off-by: Jeremy White <jwhite@codeweavers.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-12-19Merge branch 'maint' to sync with GIT 1.6.0.6Libravatar Junio C Hamano1-0/+3
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-12-19SubmittingPatches: mention the usage of real name in Signed-off-by: linesLibravatar Miklos Vajna1-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>
2008-11-02Merge branch 'maint'Libravatar Junio C Hamano1-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
2008-11-01add instructions on how to send patches to the mailing list with GmailLibravatar Tom Preston-Werner1-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>
2008-08-19SubmittingPatches: fix a typoLibravatar Jim Meyering1-1/+1
Signed-off-by: Jim Meyering <meyering@redhat.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-21Rename .git/rebase to .git/rebase-applyLibravatar Johannes Schindelin1-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>
2008-07-15Rename ".dotest/" to ".git/rebase" and ".dotest-merge" to "rebase-merge"Libravatar Johannes Schindelin1-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>
2008-06-19Add a helper script to send patches with Mozilla ThunderbirdLibravatar Lukas Sandström1-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>
2008-02-16Documentation/SubmittingPatches - a suggested patch flowLibravatar Junio C Hamano1-0/+35
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-02-05Documentation/SubmittingPatches: What's Acked-by and Tested-by?Libravatar Junio C Hamano1-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>
2008-02-05Documentation/SubmittingPatches: discuss first then submitLibravatar Junio C Hamano1-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>
2008-02-05Documentation/SubmittingPatches: Instruct how to use [PATCH] Subject headerLibravatar Junio C Hamano1-1/+6
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-06Change from using email.com to example.com as example domain, as per RFC 2606.Libravatar David Symonds1-1/+1
Signed-off-by: David Symonds <dsymonds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-08SubmittingPatches: improve the 'Patch:' section of the checklistLibravatar Sergei Organov1-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>
2007-09-01Update my contact address as the maintainer.Libravatar Junio C Hamano1-1/+2
2007-06-07War on whitespaceLibravatar Junio C Hamano1-7/+7
This uses "git-apply --whitespace=strip" to fix whitespace errors that have crept in to our source files over time. There are a few files that need to have trailing whitespaces (most notably, test vectors). The results still passes the test, and build result in Documentation/ area is unchanged. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-06-02Update to SubmittingPatchesLibravatar Johannes Schindelin1-0/+4
Make people aware of our testsuite, and of non-ASCII encodings. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-05-24Remove git-applypatchLibravatar Junio C Hamano1-2/+2
The previous one removed git-applymbox, which was the sole user of this tool. Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-05-21Merge branch 'maint-1.5.1' into maintLibravatar Junio C Hamano1-0/+13
* maint-1.5.1: git-status: respect core.excludesFile SubmittingPatches: mention older C compiler compatibility git-daemon: don't ignore pid-file write failure
2007-05-21SubmittingPatches: mention older C compiler compatibilityLibravatar Johannes Schindelin1-0/+13
We do not appreciate C99 initializers, declarations after statements, or "0" instead of "NULL". Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-30Merge branch 'maint'Libravatar Junio C Hamano1-1/+9
* maint: GIT v1.5.1.3 send-email documentation: clarify --smtp-server git.7: Mention preformatted html doc location Clarify SubmittingPatches Checklist git-svn: Add 'find-rev' command Fix symlink handling in git-svn, related to PerlIO
2007-04-30Clarify SubmittingPatches ChecklistLibravatar Jari Aalto1-1/+9
Separate things to be checked when making commits, and things to be checked when sending patches. Signed-off-by: Jari Aalto <jari.aalto@cante.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-15Add policy on user-interface changesLibravatar Andrew Ruder1-0/+3
Documentation/SubmittingPatches: Add note that all user interface changes should include associated documentation updates. Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-05Begin SubmittingPatches with a check listLibravatar Johannes Schindelin1-0/+27
It seems that some people prefer a short list to a long text. But even for the latter group, a quick reminder list is useful. So, add a check list to Documentation/SubmittingPatches of what to do to get your patch accepted. Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-07Documentation: add KMail in SubmittingPatchesLibravatar Michael1-1/+17
Signed-off-by: Michael <barra_cuda@katamail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-27Document --check option to git diff.Libravatar Bill Lear1-1/+2
Signed-off-by: Bill Lear <rael@zopyra.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-17Documentation/SubmittingPatches: Gnus tipsLibravatar Junio C Hamano1-1/+19
Also warn about format=flowed (aka 'flawed'). Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-11-21Teach SubmittingPatches about git-commit -sLibravatar Paolo Ciarrocchi1-0/+3
As discussed on git mailing list let's teach the reader about the possiblity to have automatically signed off the commit running the git-commit -s command Signed-off-by: Paolo Ciarrocchi <paolo.ciarrocchi@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-10-25Documentation/SubmittingPatches: 3+1 != 6Libravatar Junio C Hamano1-1/+1
Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-10-24Documentation: note about contrib/.Libravatar Junio C Hamano1-0/+5
Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-07-09Assorted typo fixesLibravatar Pavel Roskin1-1/+1
Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-05-18SubmittingPatches: The download location of External Editor has movedLibravatar Lukas Sandström1-2/+2
Signed-off-by: Lukas Sandström <lukass@etek.chalmers.se> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-02-17SubmittingPatches: note on whitespacesLibravatar Junio C Hamano1-11/+19
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-31Add Pine 4.63 help from Daniel.Libravatar Junio C Hamano1-0/+12
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-29[PATCH] Update Thunderbird specific hints.Libravatar A Large Angry SCM1-6/+2
Setting the wraplength to zero keeps the bird from trimming WS. Signed-off-by: <gitzilla@gmail.com> (cherry picked from 1d535d525d6a0ddddc3755065d721278bc5f0aff commit)
2005-08-28Update SubmittingPatches.Libravatar Junio C Hamano1-7/+55
- It does not matter how I read git list. What matters is that I do not necessarily read everything on it. - Talk a bit about how to use applymbox to check one's own patches. - Talk a bit about PGP signed patches. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-28[PATCH] Add footnote about Thunderbird about trimming trailing WS.Libravatar A Large Angry SCM1-2/+4
Add footnote about Thunderbird about trimming trailing WS. Signed-off-by: <gitzilla@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-21 11:10:41 +0000