From a54d72c628d2c9710b26020691684999baa5d904 Mon Sep 17 00:00:00 2001 From: John Baldwin Date: Wed, 29 Sep 1999 02:12:37 +0000 Subject: [PATCH] Merge the ports committers' guide into the new committers' guide. Reviewed by: nik --- .../articles/committers-guide/article.sgml | 340 ++++++++++++++++++ .../articles/committers-guide/article.sgml | 340 ++++++++++++++++++ 2 files changed, 680 insertions(+) diff --git a/en_US.ISO8859-1/articles/committers-guide/article.sgml b/en_US.ISO8859-1/articles/committers-guide/article.sgml index 08caadab2c..805b8df008 100644 --- a/en_US.ISO8859-1/articles/committers-guide/article.sgml +++ b/en_US.ISO8859-1/articles/committers-guide/article.sgml @@ -772,4 +772,344 @@ MLINKs installed. + + + Ports Specific FAQ + + + + Importing a New Port + + + + How do I import a new port? + + + + First, please read the section about repository + copy. + + To import a new port, the easiest way is to use the + easy-import script on + freefall. It will ask you some + questions and import the port in the directory you + specifies. It will also add an entry to the modules + file. It was written by &a.joerg; so please send mail + to him if you have questions about + easy-import. + + One thing it will not do for you is add the port to + the parent (category) Makefile. + You have to do that yourself. + + + + + + Any other things I need to know when I import a new + port? + + + + Check the port, preferably to make sure it compiles + 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 + + + The Handbook's + porting + section contains more detailed + instructions. + + Use &man.portlint.1; to check the syntax of the port. + You don't necessarily have to eliminate all warnings but + make sure you have fixed the simple ones. + + If the port came from a submitter who has not + contributed to the project before, add that person's + name to the Handbook's + Additional Contributors + section. + + Close the PR if the port came in as a PR. To close + a PR, just do + edit-pr PR# + on freefall and change the + state from open + to closed. You will be asked to + enter a log message and then you are done. + + + + + + Repository Copies + + + + When do we need a repository copy? + + + + When you want to import a port that is related to + any port that is already in the tree in a separate + directory, please send mail to the ports manager asking + about it. Here related means + it is a different version or a slightly modified + version. Examples are + print/ghostscript* (different + versions) and x11-wm/windowmaker* + (English-only and internationalized version). + + Another example is when a port is moved from one + subdirectory to another, or when you want to change the + name of a directory due to the authors calling their + software by a different name even though it's a + descendant of a port already in a tree. + + + + + + When do we not need a + repository copy? + + + + When there is no history to preserve. If a port is + imported into a wrong category and is moved immediately, + it suffices to simply cvs remove the + old one and cvs import the new + one. + + + + + + What do I need to do? + + + + Send mail to the ports manager, who will do a copy + from the old location/name to the new location/name. + You will then get a notice, at which point you are + expected to perform the following: + + + + cvs remove the old port (if + necessary) + + + + Adjust the parent (category) + Makefile + + + + Update CVSROOT/modules + + + + If other ports depend on the updated port, + change their Makefiles' + dependency lines + + + + If the port changed categories, modify the + CATEGORIES line of the port's + Makefile accordingly + + + + + + + + Ports Freeze + + + + What is a ports freeze? + + + + Before a release, it is necessary to restrict + commits to the ports tree for a short period of time + while the packages and the release itself are being + built. This is to ensure consistency among the various + parts of the release, and is called the ports + freeze. + + + + + + How long is a ports freeze? + + + + Usually two to three days. + + + + + + What does it mean to me? + + + + During the ports freeze, you are not allowed to + commit anything to the tree without explicit approval + from the ports manager. Explicit + approval here means either of the + following: + + + + You asked the ports manager and got a reply + saying, Go ahead and commit + it. + + + + The ports manager sent a mail to you or the + mailing lists during the ports freeze pointing out + that the port is broken and has to be fixed. + + + + Note that you do not have implicit permission to fix + a port during the freeze just because it is + broken. + + + + + + How do I know when the ports freeze starts? + + + + The ports manager will send out warning messages to + the freebsd-ports and + cvs-committers mailing lists announcing + the start of the impending release, usually two or three + weeks in advance. The exact starting time will not be + determined until a few days before the actual release. + This is because the ports freeze has to be synchronized + with the release, and it is usually not known until then + when exactly the release will be rolled. + + When the freeze starts, there will be another + announcement to the cvs-committers list, + of course. + + + + + + How do I know when the ports freeze ends? + + + + A few hours after the release, the ports manager + will send out a mail to the freebsd-ports + and cvs-committers mailing lists + announcing the end of the ports freeze. Note that the + release being cut does not automatically end the freeze. + We have to make sure there will not be any last minute + snafus that result in an immediate re-rolling of the + release. + + + + + + Miscellaneous Questions + + + + How do I know if my port is building correctly or + not? + + + + First, go check + http://bento.FreeBSD.org/~asami/errorlogs/. + + There you will find error logs from the latest package + building runs on 3-stable and 4-current. + + However, just because the port doesn't show up there + doesn't mean it's building correctly. (One of the + dependencies may have failed, for instance.) Here are + the relevant directories on bento, so feel free to dig + around. + + /a/asami/portbuild/3/errors error logs from latest 3-stable run + /logs all logs from latest 3-stable run + /packages packages from latest 3-stable run + /bak/errors error logs from last complete 3-stable run + /bak/logs all logs from last complete 3-stable run + /bak/packages packages from last complete 3-stable run + /4/errors error logs from latest 4-current run + /logs all logs from latest 4-current run + /packages packages from latest 4-current run + /bak/errors error logs from last complete 4-current run + /bak/logs all logs from last complete 4-current run + /bak/packages packages from last complete 4-current run + + + Basically, if the port shows up in + packages, or it is in + logs but not in + errors, it built fine. (The + errors directories are what you get + from the web page.) + + + + + + I added a new port. Do I need to add it to the + INDEX? + + + + No. The ports manager will regenerate the + INDEX and commit it every few + days. + + + + + + Are there any other files I'm not allowed to + touch? + + + + Any file right under ports/, or + any file under a subdirectory that starts with an + uppercase letter (Mk, + Tools, etc.). In particular, the + ports manager is very protective about + ports/Mk/bsd.port.mk so don't + commit changes to it unless you want to face his + wra(i)th. + + + + + 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 08caadab2c..805b8df008 100644 --- a/en_US.ISO_8859-1/articles/committers-guide/article.sgml +++ b/en_US.ISO_8859-1/articles/committers-guide/article.sgml @@ -772,4 +772,344 @@ MLINKs installed. + + + Ports Specific FAQ + + + + Importing a New Port + + + + How do I import a new port? + + + + First, please read the section about repository + copy. + + To import a new port, the easiest way is to use the + easy-import script on + freefall. It will ask you some + questions and import the port in the directory you + specifies. It will also add an entry to the modules + file. It was written by &a.joerg; so please send mail + to him if you have questions about + easy-import. + + One thing it will not do for you is add the port to + the parent (category) Makefile. + You have to do that yourself. + + + + + + Any other things I need to know when I import a new + port? + + + + Check the port, preferably to make sure it compiles + 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 + + + The Handbook's + porting + section contains more detailed + instructions. + + Use &man.portlint.1; to check the syntax of the port. + You don't necessarily have to eliminate all warnings but + make sure you have fixed the simple ones. + + If the port came from a submitter who has not + contributed to the project before, add that person's + name to the Handbook's + Additional Contributors + section. + + Close the PR if the port came in as a PR. To close + a PR, just do + edit-pr PR# + on freefall and change the + state from open + to closed. You will be asked to + enter a log message and then you are done. + + + + + + Repository Copies + + + + When do we need a repository copy? + + + + When you want to import a port that is related to + any port that is already in the tree in a separate + directory, please send mail to the ports manager asking + about it. Here related means + it is a different version or a slightly modified + version. Examples are + print/ghostscript* (different + versions) and x11-wm/windowmaker* + (English-only and internationalized version). + + Another example is when a port is moved from one + subdirectory to another, or when you want to change the + name of a directory due to the authors calling their + software by a different name even though it's a + descendant of a port already in a tree. + + + + + + When do we not need a + repository copy? + + + + When there is no history to preserve. If a port is + imported into a wrong category and is moved immediately, + it suffices to simply cvs remove the + old one and cvs import the new + one. + + + + + + What do I need to do? + + + + Send mail to the ports manager, who will do a copy + from the old location/name to the new location/name. + You will then get a notice, at which point you are + expected to perform the following: + + + + cvs remove the old port (if + necessary) + + + + Adjust the parent (category) + Makefile + + + + Update CVSROOT/modules + + + + If other ports depend on the updated port, + change their Makefiles' + dependency lines + + + + If the port changed categories, modify the + CATEGORIES line of the port's + Makefile accordingly + + + + + + + + Ports Freeze + + + + What is a ports freeze? + + + + Before a release, it is necessary to restrict + commits to the ports tree for a short period of time + while the packages and the release itself are being + built. This is to ensure consistency among the various + parts of the release, and is called the ports + freeze. + + + + + + How long is a ports freeze? + + + + Usually two to three days. + + + + + + What does it mean to me? + + + + During the ports freeze, you are not allowed to + commit anything to the tree without explicit approval + from the ports manager. Explicit + approval here means either of the + following: + + + + You asked the ports manager and got a reply + saying, Go ahead and commit + it. + + + + The ports manager sent a mail to you or the + mailing lists during the ports freeze pointing out + that the port is broken and has to be fixed. + + + + Note that you do not have implicit permission to fix + a port during the freeze just because it is + broken. + + + + + + How do I know when the ports freeze starts? + + + + The ports manager will send out warning messages to + the freebsd-ports and + cvs-committers mailing lists announcing + the start of the impending release, usually two or three + weeks in advance. The exact starting time will not be + determined until a few days before the actual release. + This is because the ports freeze has to be synchronized + with the release, and it is usually not known until then + when exactly the release will be rolled. + + When the freeze starts, there will be another + announcement to the cvs-committers list, + of course. + + + + + + How do I know when the ports freeze ends? + + + + A few hours after the release, the ports manager + will send out a mail to the freebsd-ports + and cvs-committers mailing lists + announcing the end of the ports freeze. Note that the + release being cut does not automatically end the freeze. + We have to make sure there will not be any last minute + snafus that result in an immediate re-rolling of the + release. + + + + + + Miscellaneous Questions + + + + How do I know if my port is building correctly or + not? + + + + First, go check + http://bento.FreeBSD.org/~asami/errorlogs/. + + There you will find error logs from the latest package + building runs on 3-stable and 4-current. + + However, just because the port doesn't show up there + doesn't mean it's building correctly. (One of the + dependencies may have failed, for instance.) Here are + the relevant directories on bento, so feel free to dig + around. + + /a/asami/portbuild/3/errors error logs from latest 3-stable run + /logs all logs from latest 3-stable run + /packages packages from latest 3-stable run + /bak/errors error logs from last complete 3-stable run + /bak/logs all logs from last complete 3-stable run + /bak/packages packages from last complete 3-stable run + /4/errors error logs from latest 4-current run + /logs all logs from latest 4-current run + /packages packages from latest 4-current run + /bak/errors error logs from last complete 4-current run + /bak/logs all logs from last complete 4-current run + /bak/packages packages from last complete 4-current run + + + Basically, if the port shows up in + packages, or it is in + logs but not in + errors, it built fine. (The + errors directories are what you get + from the web page.) + + + + + + I added a new port. Do I need to add it to the + INDEX? + + + + No. The ports manager will regenerate the + INDEX and commit it every few + days. + + + + + + Are there any other files I'm not allowed to + touch? + + + + Any file right under ports/, or + any file under a subdirectory that starts with an + uppercase letter (Mk, + Tools, etc.). In particular, the + ports manager is very protective about + ports/Mk/bsd.port.mk so don't + commit changes to it unless you want to face his + wra(i)th. + + + + +