Gentoo Archives: gentoo-doc

From: Joshua Saddler <nightmorph@g.o>
To: gentoo-doc@l.g.o
Subject: Re: [gentoo-doc] writing doc for logcheck
Date: Sun, 09 May 2010 19:39:09
Message-Id: 20100509123836.286ea4f4@angelstorm
In Reply to: Re: [gentoo-doc] writing doc for logcheck by "Paweł Hajdan
1 On Sun, 09 May 2010 19:37:35 +0200
2 "Paweł Hajdan, Jr." <phajdan.jr@g.o> wrote:
3 > Pinging you then. By the way, I have opened a stabilization bug and
4 > we're getting some first Arch Testers' reports. It would be nice to get
5 > the GuideXML quite ready for the inclusion. :)
6
7 Actually, it looks pretty good. You musta cleaned it up. Only a couple of things left:
8
9 1. In CL 1.5, add parentheses around the RED comment text, just like you did in CL 1.4.
10
11 2. Just to make it more clear, change "${EDITOR}" in CL 1.6 to "nano -w" -- we generally use nano for basic editing examples. Experienced users will already be using a different tools, but inexperienced users might not know what ${EDITOR} is.
12
13 3. Maybe add <c> tags around each instance of logcheck where it is referred to as a program name. For the *user* "logcheck" you can leave it as-is. You might also want to enclose syslog-ng in <c> tags, too, before CL 1.3.
14
15 4. MOST IMPORTANT: do **not** do "echo app-admin/logcheck ~arch >> whatever"
16 - This is wrong! You NEVER add the ~arch keyword!! Just list app-admin/logcheck in package.keywords. This applies to any package in Portage.
17 - So CL 1.2 should be:
18
19 # <i>echo app-admin/logcheck >> /etc/portage/package.keywords</i>
20
21 -----
22
23 Open a GDP bug once logcheck is stabilized, and we can add the revised guide to /doc/en/

Attachments

File name MIME type
signature.asc application/pgp-signature

Replies

Subject Author
Re: [gentoo-doc] writing doc for logcheck "Paweł Hajdan