From d3d532c64fd45e329f2249140102981128e7f1b2 Mon Sep 17 00:00:00 2001 From: Nik Clayton Date: Thu, 8 Jun 2000 18:12:54 +0000 Subject: [PATCH] * RCS Date string in * Add year to * Explain how you can use CVSup to download the PR database, and then teach a local copy of GNATS about the files you've installed, to make it easier to query them without being online all the time. Prompted by Warner's query on -committers last month. Doing this is actually fairly trivial, but I figure a lot of you'll benefit from it. * Change some &prompt.user; to &prompt.root; (as far as I can see, you need to run the commands as root). * Update a link to point to the Porter's Handbook. --- .../articles/committers-guide/article.sgml | 122 ++++++++++++++++-- .../articles/committers-guide/article.sgml | 122 ++++++++++++++++-- 2 files changed, 220 insertions(+), 24 deletions(-) diff --git a/en_US.ISO8859-1/articles/committers-guide/article.sgml b/en_US.ISO8859-1/articles/committers-guide/article.sgml index b1c583f3cb..e29f3937dc 100644 --- a/en_US.ISO8859-1/articles/committers-guide/article.sgml +++ b/en_US.ISO8859-1/articles/committers-guide/article.sgml @@ -16,10 +16,11 @@ - September 1999 + $Date: 2000-06-08 18:12:54 $ - 1999-2000 + 1999 + 2000 The FreeBSD Documentation Project @@ -287,6 +288,103 @@ &man.send-pr.1; + + You can run a local copy of GNATS, and then integrate the FreeBSD + GNATS tree in to it using CVSup. Then you can run GNATS commands + locally, or us other interfaces, such as tkgnats. + This lets you query the PR database without needing to be connected to + the Internet. + + + Using a local GNATS tree + + + If you are not already downloading the GNATS tree, add this line + to your supfile, and re-sup. + + gnats release=current prefix=/usr + + This will place the FreeBSD GNATS tree in + /usr/gnats. You can use a + refuse file to control which categories to + receive. For example, to only receive docs PRs, + put this line in + /usr/local/etc/cvsup/sup/refuse + The precise path depends on the *default + base setting in your + supfile. + . + + gnats/[a-ce-z]* + + The rest of this examples assume you have only supped the + docs category. Adjust them as necessary, + depending on the categories you are synching. + + + + Install the GNATS port from + ports/databases/gnats. This will place the + various GNATS directories under + $PREFIX/share/gnats. + + + + Symlink the GNATS directories you are supping under the version + of GNATS you have installed. + + &prompt.root; cd /usr/local/share/gnats/gnats-db +&prompt.root; ln -s /usr/gnats/docs + + Repeat as necessary, depending on how many GNATS categories you + are synching. + + + + Update the GNATS categories file with these + cageories. The file is + $PREFIX/share/gnats/gnats-db/gnats-adm/categories. + + # This category is mandatory +pending:Category for faulty PRs:gnats-admin: +# +# FreeBSD categories +# +docs:Documentation Bug:nik: + + + + Run $PREFIX/libexec/gnats/gen-index to + recreate the GNATS index. The output has to be redirected to + $PREFIX/share/gnats/gnats-db/gnats-adm/index. + You can do this periodically from &man.cron.8;, or run &man.cvsup.1; + from a shell script that does this as well. + + &prompt.root; /usr/local/libexec/gnats/gen-index \ + > /usr/local/share/gnats/gnats-db/gnats-adm/index + + + + Test the configuration by querying the PR database. This + command shows open docs PRs. + + &prompt.root; query-pr -c docs -s open + + Other interfaces, like + ports/databases/tkgnats should also work + nicely. + + + + Pick a PR and close it. + + + + + This procedure only works to allow you to view and query the PRs + locally. To edit or close them you will still have to log in to + freefall and do it from there. + @@ -894,18 +992,18 @@ and packages correctly. This is the recommended sequence: - &prompt.user; make install -&prompt.user; make package -&prompt.user; make deinstall -&prompt.user; pkg_add package you built above -&prompt.user; make deinstall -&prompt.user; make reinstall -&prompt.user; make package + &prompt.root; make install +&prompt.root; make package +&prompt.root; make deinstall +&prompt.root; pkg_add package you built above +&prompt.root; make deinstall +&prompt.root; make reinstall +&prompt.root; make package - The Handbook's - porting - section contains more detailed + The + Porters + Handbook contains more detailed instructions. Use &man.portlint.1; to check the syntax of the port. diff --git a/en_US.ISO_8859-1/articles/committers-guide/article.sgml b/en_US.ISO_8859-1/articles/committers-guide/article.sgml index b1c583f3cb..e29f3937dc 100644 --- a/en_US.ISO_8859-1/articles/committers-guide/article.sgml +++ b/en_US.ISO_8859-1/articles/committers-guide/article.sgml @@ -16,10 +16,11 @@ - September 1999 + $Date: 2000-06-08 18:12:54 $ - 1999-2000 + 1999 + 2000 The FreeBSD Documentation Project @@ -287,6 +288,103 @@ &man.send-pr.1; + + You can run a local copy of GNATS, and then integrate the FreeBSD + GNATS tree in to it using CVSup. Then you can run GNATS commands + locally, or us other interfaces, such as tkgnats. + This lets you query the PR database without needing to be connected to + the Internet. + + + Using a local GNATS tree + + + If you are not already downloading the GNATS tree, add this line + to your supfile, and re-sup. + + gnats release=current prefix=/usr + + This will place the FreeBSD GNATS tree in + /usr/gnats. You can use a + refuse file to control which categories to + receive. For example, to only receive docs PRs, + put this line in + /usr/local/etc/cvsup/sup/refuse + The precise path depends on the *default + base setting in your + supfile. + . + + gnats/[a-ce-z]* + + The rest of this examples assume you have only supped the + docs category. Adjust them as necessary, + depending on the categories you are synching. + + + + Install the GNATS port from + ports/databases/gnats. This will place the + various GNATS directories under + $PREFIX/share/gnats. + + + + Symlink the GNATS directories you are supping under the version + of GNATS you have installed. + + &prompt.root; cd /usr/local/share/gnats/gnats-db +&prompt.root; ln -s /usr/gnats/docs + + Repeat as necessary, depending on how many GNATS categories you + are synching. + + + + Update the GNATS categories file with these + cageories. The file is + $PREFIX/share/gnats/gnats-db/gnats-adm/categories. + + # This category is mandatory +pending:Category for faulty PRs:gnats-admin: +# +# FreeBSD categories +# +docs:Documentation Bug:nik: + + + + Run $PREFIX/libexec/gnats/gen-index to + recreate the GNATS index. The output has to be redirected to + $PREFIX/share/gnats/gnats-db/gnats-adm/index. + You can do this periodically from &man.cron.8;, or run &man.cvsup.1; + from a shell script that does this as well. + + &prompt.root; /usr/local/libexec/gnats/gen-index \ + > /usr/local/share/gnats/gnats-db/gnats-adm/index + + + + Test the configuration by querying the PR database. This + command shows open docs PRs. + + &prompt.root; query-pr -c docs -s open + + Other interfaces, like + ports/databases/tkgnats should also work + nicely. + + + + Pick a PR and close it. + + + + + This procedure only works to allow you to view and query the PRs + locally. To edit or close them you will still have to log in to + freefall and do it from there. + @@ -894,18 +992,18 @@ and packages correctly. This is the recommended sequence: - &prompt.user; make install -&prompt.user; make package -&prompt.user; make deinstall -&prompt.user; pkg_add package you built above -&prompt.user; make deinstall -&prompt.user; make reinstall -&prompt.user; make package + &prompt.root; make install +&prompt.root; make package +&prompt.root; make deinstall +&prompt.root; pkg_add package you built above +&prompt.root; make deinstall +&prompt.root; make reinstall +&prompt.root; make package - The Handbook's - porting - section contains more detailed + The + Porters + Handbook contains more detailed instructions. Use &man.portlint.1; to check the syntax of the port.