Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 247266 - better / more patch guidelines
Summary: better / more patch guidelines
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All All
: High enhancement
Assignee: Gentoo Devmanual Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-11-17 20:39 UTC by SpanKY
Modified: 2021-02-20 08:05 UTC (History)
2 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description SpanKY gentoo-dev 2008-11-17 20:39:27 UTC
should integrate stuff ive written here:
http://dev.gentoo.org/~vapier/clean-patches

into this page:
http://devmanual.gentoo.org/ebuild-writing/misc-files/patches/index.html
Comment 1 Ulrich Müller gentoo-dev 2020-01-23 10:30:54 UTC
(In reply to SpanKY from comment #0)
> should integrate stuff ive written here:
> http://dev.gentoo.org/~vapier/clean-patches

Can you sign this off under CC-BY-SA-4.0?
Comment 2 Sam James archtester Gentoo Infrastructure gentoo-dev Security 2021-02-15 08:44:25 UTC
ping vapier
Comment 3 SpanKY gentoo-dev 2021-02-15 13:30:46 UTC
i thought i already signed off on this.  i vaguely recall Ulrich pinging me via e-mail.
Comment 4 Ulrich Müller gentoo-dev 2021-02-15 16:23:08 UTC
(In reply to SpanKY from comment #3)
> i thought i already signed off on this.  i vaguely recall Ulrich pinging me
> via e-mail.

Sorry, I don't have anything for this issue (or at least I cannot find it). Maybe that was another issue like bug 700364?

Could you simply post the Signed-off-by line as a comment to this bug? Then we would be all set.
Comment 5 SpanKY gentoo-dev 2021-02-15 20:23:40 UTC
(In reply to Ulrich Müller from comment #4)

prob not worth trying to figure out where the packets got dropped

Signed-off-by: Mike Frysinger <vapier@gentoo.org>
Comment 6 Ulrich Müller gentoo-dev 2021-02-16 17:50:13 UTC
Initial version of a pull request created:
https://github.com/gentoo/devmanual/pull/192

I've added devbook markup, used uppercase for sentence beginnings, changed some sentences from first-person to third-person style, and modernized the text a bit (e.g., eapply instead of epatch). I've also removed some of the "cow butts" and "nipple clamps" (the devmanual is informal, but not _so_ informal. :) Otherwise I've tried to keep the original style.
Comment 7 Sam James archtester Gentoo Infrastructure gentoo-dev Security 2021-02-16 18:04:14 UTC
(In reply to SpanKY from comment #5)
> (In reply to Ulrich Müller from comment #4)
> 
> prob not worth trying to figure out where the packets got dropped
> 
> Signed-off-by: Mike Frysinger <vapier@gentoo.org>

Thanks a bunch for the original guide. I've wanted to get this into the devmanual for ages!
Comment 8 SpanKY gentoo-dev 2021-02-16 20:42:12 UTC
(In reply to Ulrich Müller from comment #6)

i wrote that thing like 13 years ago.  i'd use different prose nowadays too :).  i wouldn't sweat the style at this point, just the substance.
Comment 9 Larry the Git Cow gentoo-dev 2021-02-20 08:00:55 UTC
The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=8ffb4ecb220c9126a9a57ac3d2591a2604cdd438

commit 8ffb4ecb220c9126a9a57ac3d2591a2604cdd438
Author:     Ulrich Müller <ulm@gentoo.org>
AuthorDate: 2021-02-16 19:31:37 +0000
Commit:     Ulrich Müller <ulm@gentoo.org>
CommitDate: 2021-02-20 07:54:02 +0000

    ebuild-writing/misc-files/patches: Convert to DevBook XML markup
    
    - Start sentences with uppercase letters
    - Change some sentences from first-person to third-person
    - Less informal/colloquial style
    - Modernise the text a little (e.g., eapply instead of epatch)
    - Be more in line with GLEP 66 (e.g., "Bug" instead of "Gentoo-Bug-URL")
    
    Closes: https://bugs.gentoo.org/247266
    Closes: https://github.com/gentoo/devmanual/pull/192
    Signed-off-by: Ulrich Müller <ulm@gentoo.org>

 ebuild-writing/misc-files/patches/text.xml | 337 +++++++++++++++++------------
 1 file changed, 200 insertions(+), 137 deletions(-)

Additionally, it has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6613e9d82f910d77616f15d916ab3d3596f91399

commit 6613e9d82f910d77616f15d916ab3d3596f91399
Author:     Ulrich Müller <ulm@gentoo.org>
AuthorDate: 2021-02-16 19:27:36 +0000
Commit:     Ulrich Müller <ulm@gentoo.org>
CommitDate: 2021-02-20 07:53:57 +0000

    ebuild-writing/misc-files/patches: Add section about clean patches
    
    Taken from https://dev.gentoo.org/~vapier/clean-patches
    (verbatim, except for escaping reserved characters).
    
    Original-Author: Mike Frysinger <vapier@gentoo.org>
    Bug: https://bugs.gentoo.org/247266
    Signed-off-by: Mike Frysinger <vapier@gentoo.org>
    Signed-off-by: Ulrich Müller <ulm@gentoo.org>

 appendices/contributors/text.xml           |   3 +
 ebuild-writing/misc-files/patches/text.xml | 214 +++++++++++++++++++++++++++++
 2 files changed, 217 insertions(+)
Comment 10 Ulrich Müller gentoo-dev 2021-02-20 08:05:32 UTC
Thanks.
Sorry that it took such a long time until this was merged.