Index: head/en_US.ISO8859-1/articles/p4-primer/article.xml
===================================================================
--- head/en_US.ISO8859-1/articles/p4-primer/article.xml (revision 51678)
+++ head/en_US.ISO8859-1/articles/p4-primer/article.xml (nonexistent)
@@ -1,910 +0,0 @@
-
-
-
-
-
- Perforce in &os; Development
-
-
-
-
- Scott
- Long
-
-
-
- scottl@FreeBSD.org
-
-
-
-
-
-
- &tm-attrib.freebsd;
- &tm-attrib.general;
-
-
- $FreeBSD$
-
- $FreeBSD$
-
-
-
- Introduction
-
- The &os; project uses the
- Perforce version control system to
- manage experimental projects that are not ready for the main
- Subversion repository.
-
-
- Availability, Documentation, and Resources
-
- While Perforce is a commercial
- product, the client software for interacting with the server
- is freely available from Perforce. It can be easily installed
- on &os; via the devel/p4 port or can be
- downloaded from the Perforce web
- site at http://www.perforce.com/downloads/helix#clients,
- which also offers client applications for other OS's.
-
- While there is a GUI client available, most people use the
- command line application called p4. This
- document is written from the point of view of using this
- command.
-
- Detailed documentation is available online at https://www.perforce.com/perforce/doc.current/manuals/p4guide/index.html.
-
- Reading the Perforce User's Guide and
- Perforce Command Reference is highly
- recommended. The p4 application
- also contains an extensive amount of online help accessible
- via p4 help.
-
- The &os; Perforce server is
- hosted on perforce.freebsd.org, port
- 1666. The repository is browsable online
- at http://p4web.freebsd.org.
-
-
-
-
- Getting Started
-
- The first step to using Perforce
- is to obtain an account on the server. If you already have a
- FreeBSD.org
- account, log into freefall, run the following
- command, and enter a password that is not the same as your &os;
- login or any other SSH passphrase:
-
- &prompt.user; /usr/local/bin/p4newuser
-
- Of course if you do not have a FreeBSD.org account, you
- will need to coordinate with your sponsor.
-
-
- An email will be sent to your &os; address that contains
- the password you specified above in cleartext. Be sure to
- change the password once your
- Perforce account has been
- created!
-
-
- The next step is to set the environment variables that
- p4 needs, and verify that it can connect to
- the server. The P4PORT variable is required to
- be set for all operations, and specifies the appropriate
- Perforce server to talk to. For the
- &os; project, set it like so:
-
- &prompt.user; export P4PORT=perforce.freebsd.org:1666
-
-
- Users with shell access on the FreeBSD.org cluster may
- wish to tunnel the Perforce
- client-server protocol via an SSH tunnel, in which case the
- above string should be set to
- localhost.
-
-
- The &os; server also requires that the P4USER
- and P4PASSWD variables be set. Use the username
- and password from above, like so:
-
- &prompt.user; export P4USER=username
-&prompt.user; export P4PASSWD=password
-
- Test that this works by running the following
- command:
-
- &prompt.user; p4 info
-
- This should return a list of information about the server.
- If it does not, check that you have the P4PORT
- variable set correctly.
-
-
-
- Clients
-
- Perforce provides access to the
- repository and tracks state on a per-client basis. In
- Perforce terms, a client is a
- specification that maps files and directories from the
- repository to the local machine. Each user can have multiple
- clients, and each client can access different or overlapping
- parts of the repository. The client also specifies the root
- directory of the file tree that it maps, and it specifies the
- machine that the tree lives on. Thus, working on multiple
- machines requires that multiple clients be used.
-
- Clients may be accessed via p4 client.
- Running this command with no arguments will bring up a client
- template in an editor, allowing you to create a new client for
- your work. The important fields in this template are explained
- below:
-
-
-
- Client:
-
-
- This is the name of the client spec. It can be
- anything you want, but it must be unique within the
- Perforce server. A naming
- convention that is commonly used is
- username_machinename,
- which makes it easy to identify clients when browsing
- them. A default name will be filled in that is just the
- machine name.
-
-
-
-
- Description:
-
-
- This can contain a simple text description to help
- identify the client.
-
-
-
-
- Root:
-
-
- This is the local directory that will serve as the
- root directory of all the files in the client mapping.
- This should be a unique location in your filesystem that
- does not overlap with other files or
- Perforce clients.
-
-
-
-
- Options:
-
-
- Most of the default options are fine, though it is
- usually a good idea to make sure that the
- and
- options are present and do not have a
- no prefix on them. Details about each
- option are in the Perforce
- docs.
-
-
-
-
- LineEnd:
-
-
- This handles CR-LF conversions and should be left to
- the default unless you have special needs for it.
-
-
-
-
- View:
-
-
- This is where the server-to-local file mappings go.
- The default is
-
- //depot/... //client/...
-
- This will map the entire
- Perforce repository to the
- Root directory of your client.
- DO NOT USE THIS DEFAULT! The &os;
- repo is huge, and trying to map and sync it all will take
- an enormous amount of resources. Instead, only map the
- section of the repo that you intend to work on. For
- example, there is the smpng project tree at
- //depot/projects/smpng. A mapping
- for this might look like:
-
- //depot/projects/smpng/... //client/...
-
- The ... should be taken literally.
- It is a Perforce idiom for
- saying this directory and all files and directories
- below it.
-
- A Perforce view can contain multiple
- mappings. Say you want to map in both the SMPng tree and
- the NFS tree. Your View might look like:
-
- //depot/projects/smpng/... //client/smpng/...
- //depot/projects/nfs/... //client/nfs/...
-
- Remember that the client is
- the name of the client that was specified in the
- Client section, but in the
- View it also resolves to the directory
- that was specified in the Root
- section.
-
- Also note that the same file or directory cannot be
- mapped multiple times in a single view. The following is
- illegal and will produce undefined results:
-
- //depot/projects/smpng/... //client/smpng-foo/...
- //depot/projects/smpng/... //client/smpng-bar/...
-
- Views are a tricky part of the learning experience
- with Perforce, so do not be
- afraid to ask questions.
-
-
-
-
- Existing clients can be listed via p4
- clients. They can be viewed without being modified
- via p4 client -o
- clientname.
-
- Whenever you are interacting with files in
- Perforce, the P4CLIENT
- environment variable must be set to the name of the client that
- you are using, like so:
-
- &prompt.user; export P4CLIENT=myclientname
-
- Note that client mappings in the repository are not
- exclusive; multiple clients can map in the same part of the
- repository. This allows multiple people to access and modify
- the same parts of the repository, allowing a team of people to
- work together on the same code.
-
-
-
- Syncing
-
- Once you have a client specification defined and the
- P4CLIENT variable set, the next step is to pull
- the files for that client down to your local machine. This is
- done with p4 sync, which instructs
- Perforce to synchronize the local
- files in your client with the repository. The first time it
- runs, it will download all of the files. Subsequent runs will
- only download files that have changed since the previous run.
- This allows you to stay in sync with others whom you might be
- working with.
-
- Sync operations only work on files that the
- Perforce server knows has changed.
- If you change or delete a file locally without informing the
- server, doing a sync will not bring it back. However, doing a
- p4 sync -f will unconditionally sync all
- files, regardless of their state. This is useful for resolving
- problems where you think that your tree might be corrupt.
-
- You can sync a subset of your tree or client by specifying a
- relative path to the sync command. For example, to only sync
- the ufs directory of the
- smpng project, you might do the
- following:
-
- &prompt.user; cd projectroot/smpng
-&prompt.user; p4 sync src/sys/ufs/...
-
- Specifying a local relative path works for many other
- p4 commands.
-
-
-
- Branches
-
- One of the strongest features of
- Perforce is branching. Branches are
- very cheap to create, and moving changes between related
- branches is very easy (as will be explained later). Branches
- also allow you to do very experimental work in a sandbox-like
- environment, without having to worry about colliding with others
- or destabilizing the main tree. They also provide insulation
- against mistakes while learning the
- Perforce system. With all of these
- benefits, it makes sense for each project to have its own
- branch, and we strongly encourage that with &os;. Frequent
- submits of changes to the server are also encouraged.
-
- Similar to Subversion, the
- Perforce repository (the
- depot) is a single flat tree. Every file,
- whether a unique creation or a derivative from a branch, is
- accessible via a simple path under the server
- //depot directory. When you create a
- branch, all you are doing is creating a new path under the
- //depot. This is in sharp contrast to
- systems like CVS, where each branch lives in the same path as
- its parent. With Perforce, the
- server tracks the relationship between the files in the parent
- and child, but the files themselves live under their own
- paths.
-
- The first step to creating a branch is to create a branch
- specification. This is similar to a client specification, but
- is created via the command p4 branch
- branchname.
-
- The following important fields are explained:
-
-
-
- Branch
-
-
- The name of the branch. It can be any name, but must
- be unique within the repository. The common convention in
- &os; is to use
- username_projectname.
-
-
-
-
- Description
-
-
- This can hold a simple text description to describe
- the branch.
-
-
-
-
- View
-
-
- This is the branch mapping. Instead of mapping from
- the depot to the local machine like a client map, it maps
- between the branch parent and branch child in the depot.
- For example, you might want to create a branch of the
- smpng project. The mapping might look like:
-
- //depot/projects/smpng/... //depot/projects/my-super-smpng/...
-
- Or, you might want to create a brand new branch off of
- the stock &os; sources:
-
- //depot/vendor/freebsd/... //depot/projects/my-new-project/...
-
- This will map the &os; HEAD tree to your new
- branch.
-
-
-
-
- Creating the branch spec only saves the spec itself in the
- server, it does not modify the depot or change any files. The
- directory that you specified in the branch is empty on the
- server until you populate it.
-
- To populate your branch, first edit your client with
- p4 client and make sure that the branch
- directory is mapped in your client. You might need to add a
- View line like:
-
- //depot/projects/my-new-project/... //myclient/my-new-project/...
-
- The next step is to run p4 integrate, as
- described in the next section.
-
-
-
- Integrations
-
- Integration is the term used by
- Perforce to describe the action of
- moving changes from one part of the depot to another. It is
- most commonly done in conjunction with creating and maintaining
- branches. An integration is done when you want to initially
- populate a branch, and it is done when you want to move
- subsequent changes in the branch from the parent to the child,
- or from the child to the parent. A common example of this is
- periodically integrating changes from the vendor &os; tree to
- your child branch tree, allowing you to keep up to date with
- changes in the &os; tree. The
- Perforce server tracks the changes in
- each tree and knows when there are changes that can be
- integrated from one tree to another.
-
- The common way to do an integration is with the following
- command:
-
- &prompt.user; p4 integrate -b branchname
-
- branchname is the name given to a
- branch spec, as discussed in the previous section. This command
- will instruct Perforce to look for
- changes in the branch parent that are not yet in the child.
- From those changes it will prepare a list of diffs to move. If
- the integration is being done for the first time on a branch
- (for example doing an initial population operation), then the
- parent files will simply be copied to the child location on the
- local machine.
-
- Once the integration operation is done, you must run
- p4 resolve to accept the changes and resolve
- possible conflicts. Conflicts can arise from overlapping
- changes that happened in both the parent and child copy of a
- file. Usually, however, there are no conflicts, and
- Perforce can quickly figure out how
- to merge the changes together. Use the following commands to do
- a resolve operation:
-
- &prompt.user; p4 resolve -as
-&prompt.user; p4 resolve
-
- The first invocation will instruct
- Perforce to automatically merge the
- changes together and accept files that have no conflicts. The
- second invocation will allow you to inspect each file that has a
- possible conflict and resolve it by hand if needed.
-
- Once all of the integrated files have been resolved, they
- need to be committed back to the repository. This is done via
- p4 submit, explained in the next
- section.
-
-
-
- Submit
-
- Changes that are made locally should be committed back to
- the Perforce server for safe keeping
- and so that others can access them. This is done via
- p4 submit. When you run this command, it
- will open up a submit template in an editor. &os; has a custom
- template, and the important fields are described below:
-
- Description:
- <enter description here>
- PR:
- Submitted by:
- Reviewed by:
- Approved by:
- Obtained from:
- MFP4 after:
-
- It is good practice to provide at least 2-3 sentences that
- describe what the changes are that you are submitting. You
- should say what the change does, why it was done that way or
- what problem is solves, and what APIs it might change or other
- side effects it might have. This text should replace the
- <enter description here> line in the
- template. You should wrap your lines and start each line with a
- TAB. The tags below it are &os;-specific and can be removed if
- not needed.
-
- Files:
-
- This is automatically populated with all of the files in
- your client that were marked in the add, delete, integrate, or
- edit states on the server. It is always a very good idea to
- review this list and remove files that might not be ready
- yet.
-
- Once you save the editor session, the submit will happen to
- the server. This also means that the local copies of the
- submitted files will be copied back to the server. If anything
- goes wrong during this process, the submit will be aborted, and
- you will be notified that the submit has been turned into a
- changelist that must be corrected and re-submitted. Submits are
- atomic, so if one file fails, the entire submit is
- aborted.
-
- Submits cannot be reverted, but they can be aborted while in
- the editor by exiting the editor without changing the
- Description text.
- Perforce will complain about this the
- first time you do it and will put you back in the editor.
- Exiting the editor the second time will abort the operation.
- Reverting a submitted change is very difficult and is best
- handled on a case-by-case basis.
-
-
-
- Editing
-
- The state of each file in the client is tracked and saved on
- the server. In order to avoid collisions from multiple people
- working on the same file at once,
- Perforce tracks which files are
- opened for edit, and uses this to help with submit, sync, and
- integration operations later on.
-
- To open a file for editing, use p4 edit
- like so:
-
- &prompt.user; p4 edit filename
-
- This marks the file on the server as being in the
- edit state, which then allows it to be
- submitted after changes are made, or marks it for special
- handling when doing an integration or sync operation. Note that
- editing is not exclusive in Perforce.
- Multiple people can have the same file in the edit state (you
- will be informed of others when you run
- edit), and you can submit your changes even
- when others are still editing the file.
-
- When someone else submits a change to a file that you are
- editing, you will need to resolve his changes with yours before
- your submit will succeed. The easiest way to do this is to
- either run a p4 sync or p4
- submit and let it fail with the conflict, then run
- p4 resolve to manually resolve and accept his
- changes into your copy, then run p4 submit to
- commit your changes to the repository.
-
- If you have a file open for edit and you want to throw away
- your changes and revert it to its original state, run
- p4 revert like so:
-
- &prompt.user; p4 revert filename
-
- This resyncs the file to the contents of the server, and
- removes the edit attribute from the server. Any local changes
- that you had will be lost. This is quite useful when you have a
- made changes to a file but later decide that you do not want to
- keep them.
-
- When a file is synced, it is marked read-only in the
- filesystem. When you tell the server to open it for editing, it
- is changed to read-write on the filesystem. While these
- permissions can easily be overridden by hand, they are meant to
- gently remind you that you should being using p4
- edit. Files that have local changes but are not in
- the edit state may get overwritten when doing a p4
- sync.
-
-
-
- Changes, Descriptions, and History
-
- Changes to the Perforce depot can
- be listed via p4 changes. This will provide
- a brief description of each change, who made the change, and
- what its change number was. A change can be examined in detail
- via p4 describe
- changenumber. This will
- provide the submit log and the diffs of the actual
- change.
-
- Commonly, p4 describe is used in one
- of three ways:
-
-
-
- p4 describe -s
- CHANGE
-
-
- List a short description of changeset
- CHANGE, including the commit log of
- the particular changeset and a list of the files it
- affected.
-
-
-
-
- p4 describe -du
- CHANGE
-
-
- List a description of changeset
- CHANGE, including the commit log of
- the particular changeset, a list of the files it affected
- and a patch for each modified file, in a format similar to
- unified diff patches (but not exactly the
- same).
-
-
-
-
- p4 describe -dc
- CHANGE
-
-
- List a description of changeset
- CHANGE, including the commit log of
- the particular changeset, a list of the files it affected
- and a patch for each modified file, in a format similar to
- context diff patches (but not exactly the
- same).
-
-
-
-
- The history of a file, including all submits, integrations,
- and branches of it will be shown by p4 filelog
- filename.
-
-
-
- Diffs
-
- There are two methods of producing file diffs in
- Perforce, either against local
- changes that have not been submitted yet, or between two trees
- (or within a branch) in the depot. These are done with
- different commands, and
- :
-
-
-
- p4 diff
-
-
- This generates a diff of the local changes to files in
- the edit state. The and
- flags can be used to create unified
- or context diffs, respectively, or the
- P4DIFF environment variable can be set to a
- local diff command to be used instead. It is a very good
- idea to use this command to review your changes before
- submitting them.
-
-
-
-
- p4 diff2
-
-
- This creates a diff between arbitrary files in the
- depot, or between files specified in a branch spec. The
- diff operation takes place on the server, so
- P4DIFF variable has no effect, though the
- and flags do
- work. The two forms of this command are:
-
- &prompt.user; p4 diff2 -b branchname
-
- and
-
- &prompt.user; p4 diff2 //depot/path1 //depot/path2
-
-
-
-
- In all cases the diff will be written to the standard
- output. Unfortunately, Perforce
- produces a diff format that is slightly incompatible with the
- traditional Unix diff and patch tools. Using the
- P4DIFF variable to point to the real &man.diff.1;
- tool can help this, but only for p4 diff.
- The output of command must be
- post-processed to be useful (the flag of
- will produce unified diffs that are
- somewhat compatible, but it does not include files that have
- been added or deleted). There is a post-processing script at:
- https://svnweb.freebsd.org/base/head/tools/tools/perforce/awkdiff?view=co.
-
-
-
- Adding and Removing Files
-
- Integrating a branch will bring existing files into your
- tree, but you may still want to add new files or remove existing
- ones. Adding files is easily done be creating the file and then
- running p4 add like so:
-
- &prompt.user; p4 add filename
-
- If you want to add a whole tree of files, run a command
- like:
-
- &prompt.user; find . -type f | xargs p4 add
-
-
- Perforce can track UNIX
- symlinks too, so you can probably use
- \! -type d as the
- matching expression in &man.find.1; above. We do not commit
- symlinks into the source tree of &os; though, so this should
- not be necessary.
-
-
- Doing a p4 submit will then copy the file
- to the depot on the server. It is very important to only add
- files, not directories. Explicitly adding a directory will
- cause Perforce to treat it like a
- file, which is not what you want.
-
- Removing a file is just as easy with the
- p4 delete command like so:
-
- &prompt.user; p4 delete filename
-
- This will mark the file for deletion from the depot the next
- time that a submit is run. It will also remove the local copy
- of the file, so beware.
-
- Of course, deleting a file does not actually remove it from
- the repository.
-
- Deleted files can be resurrected by syncing them to a prior
- version. The only way to permanently remove a file is to use
- p4 obliterate. This command is irreversible
- and expensive, so it is only available to those with admin
- access.
-
-
-
- Working with Diffs
-
- Sometimes you might need to apply a diff from another source
- to a tree under Perforce control. If
- it is a large diff that affects lots of files, it might be
- inconvenient to manually run p4 edit on each
- file. There is a trick for making this easier. First, make
- sure that no files are open on your client and that your tree is
- synced and up to date. Then apply the diff using the normal
- tools, and coerce the permissions on the files if needed. Then
- run the following commands:
-
- &prompt.user; p4 diff -se ... | xargs p4 edit
-&prompt.user; p4 diff -sd ... | xargs p4 delete
-&prompt.user; find . -type f | xargs p4 add
-
- The first command tells Perforce
- to look for files that have changed, even if they are not open.
- The second command tells Perforce to
- look for files that no longer exist on the local machine but do
- exist on the server. The third command then attempts to add all
- of the files that it can find locally. This is a very
- brute-force method, but it works because
- Perforce will only add the files that
- it does not already know about. The result of running these
- commands will be a set of files that are opened for edit,
- removal, or add, as appropriate.
-
- Verify the active changelist with:
-
- &prompt.user; p4 changelist
-&prompt.user; p4 diff -du
-
- and just do a p4 submit after
- that.
-
-
-
- Renaming Files
-
- Perforce does not have a built-in
- way of renaming files or moving them to a different part of the
- tree. Simply copying a file to the new location, doing a
- p4 add on it, and a p4
- delete on the old copy, works, but does not preserve
- change history of the file. This can make future integrations
- with parents and children very bumpy, in fact. A better method
- of dealing with this is to do a one-time, in-tree integration,
- like so:
-
- &prompt.user; p4 integrate -i oldfilenewfile
-&prompt.user; p4 resolve
-&prompt.user; p4 delete oldfile
-&prompt.user; p4 submit
-
- The integration will force
- Perforce to keep a record of the
- relationship between the old and new names, which will assist it
- in future integrations. The flag tells it
- that it is a baseless integration, meaning that
- there is no branch history available for it to use in the
- integration. That is perfect for an integration like this, but
- should not be used for normal branch-based integrations.
-
-
-
- Interactions Between &os; Subversion and Perforce
-
- The &os; Perforce and
- Subversion repositories are
- completely separate. However, changes to Subversion are tracked
- at near-real-time in Perforce. Every
- 2 minutes, the Subversion server is polled for updates in the
- HEAD branch, and those updates are committed to
- Perforce in the
- //depot/vendor/freebsd/... tree. This tree
- is then available for branching and integrating to derivative
- projects. Any project that directly modifies that &os; source
- code should have this tree as its branch parent (or grandparent,
- depending on the needs), and periodic integrations and syncs
- should be done so that your tree stays up to date and avoids
- conflicts with mainline development.
-
- The bridge between Subversion and
- Perforce is one-way; changes to
- Subversion will be reflected in
- Perforce, but changes in Perforce
- will not be reflected in Subversion.
-
-
-
- Offline Operation
-
- One weakness of Perforce is that
- it assumes that network access to the server is always
- available. Most state, history, and metadata is saved on the
- server, and there is no provision for replicating the server
- like there is with SVN. It is possible to run a proxy server,
- but it only provides very limited utility for offline
- operation.
-
- The best way to work offline is to make sure that your
- client has no open files and is fully synced before going
- offline. Then when editing a file, manually change the
- permissions to read-write. When you get back online, run the
- commands listed in the to
- automatically identify files that have been edited, added, and
- removed. It is quite common to be surprised by
- Perforce overwriting a locally
- changed file that was not opened for edit, so be extra vigilant
- with this.
-
-
-
- Notes for Google Summer of Code
-
- Most &os; projects under the Google Summer of Code program
- are located on the &os; Perforce
- server under one of the following locations:
-
-
-
- //depot/projects/soc2005/project-name/...
-
-
- //depot/projects/soc2006/project-name/...
-
-
- //depot/projects/soc2007/project-name/...
-
-
- //depot/projects/soc2008/project-name/...
-
-
-
- The project mentor is responsible for choosing a suitable
- project name and getting the student going with
- Perforce.
-
- Access to the &os; Perforce
- server does not imply access to subversion, though we happily
- encourage all students to consider
- joining the project when the time is appropriate.
-
-
Property changes on: head/en_US.ISO8859-1/articles/p4-primer/article.xml
___________________________________________________________________
Deleted: svn:keywords
## -1 +0,0 ##
-FreeBSD=%H
\ No newline at end of property
Deleted: svn:mime-type
## -1 +0,0 ##
-text/sgml
\ No newline at end of property
Index: head/en_US.ISO8859-1/articles/p4-primer/Makefile
===================================================================
--- head/en_US.ISO8859-1/articles/p4-primer/Makefile (revision 51678)
+++ head/en_US.ISO8859-1/articles/p4-primer/Makefile (nonexistent)
@@ -1,19 +0,0 @@
-#
-# $FreeBSD$
-#
-# Perforce in FreeBSD Development article.
-
-DOC?= article
-
-FORMATS?= html
-WITH_ARTICLE_TOC?= YES
-
-INSTALL_COMPRESSED?= gz
-INSTALL_ONLY_COMPRESSED?=
-
-SRCS= article.xml
-
-URL_RELPREFIX?= ../../../..
-DOC_PREFIX?= ${.CURDIR}/../../..
-
-.include "${DOC_PREFIX}/share/mk/doc.project.mk"
Property changes on: head/en_US.ISO8859-1/articles/p4-primer/Makefile
___________________________________________________________________
Deleted: svn:keywords
## -1 +0,0 ##
-FreeBSD=%H
\ No newline at end of property
Index: head/en_US.ISO8859-1/articles/Makefile
===================================================================
--- head/en_US.ISO8859-1/articles/Makefile (revision 51678)
+++ head/en_US.ISO8859-1/articles/Makefile (revision 51679)
@@ -1,44 +1,43 @@
# $FreeBSD$
SUBDIR =
SUBDIR+= bsdl-gpl
SUBDIR+= building-products
SUBDIR+= committers-guide
SUBDIR+= contributing
SUBDIR+= contributors
SUBDIR+= cups
SUBDIR+= explaining-bsd
SUBDIR+= filtering-bridges
SUBDIR+= fonts
SUBDIR+= freebsd-questions
SUBDIR+= freebsd-releng
SUBDIR+= freebsd-update-server
SUBDIR+= geom-class
SUBDIR+= gjournal-desktop
SUBDIR+= hubs
SUBDIR+= ipsec-must
SUBDIR+= ldap-auth
SUBDIR+= leap-seconds
SUBDIR+= linux-emulation
SUBDIR+= linux-users
SUBDIR+= mailing-list-faq
SUBDIR+= nanobsd
SUBDIR+= new-users
-SUBDIR+= p4-primer
SUBDIR+= pam
SUBDIR+= pgpkeys
SUBDIR+= port-mentor-guidelines
SUBDIR+= pr-guidelines
SUBDIR+= problem-reports
SUBDIR+= rc-scripting
SUBDIR+= releng
SUBDIR+= remote-install
SUBDIR+= serial-uart
SUBDIR+= solid-state
SUBDIR+= vinum
SUBDIR+= vm-design
# ROOT_SYMLINKS+= new-users
DOC_PREFIX?= ${.CURDIR}/../..
.include "${DOC_PREFIX}/share/mk/doc.project.mk"
Index: head/en_US.ISO8859-1/articles/committers-guide/article.xml
===================================================================
--- head/en_US.ISO8859-1/articles/committers-guide/article.xml (revision 51678)
+++ head/en_US.ISO8859-1/articles/committers-guide/article.xml (revision 51679)
@@ -1,5399 +1,5399 @@
]>
Committer's GuideThe &os; Documentation Project1999200020012002200320042005200620072008200920102011201220132014201520162017The &os; Documentation Project
&tm-attrib.freebsd;
&tm-attrib.coverity;
&tm-attrib.ibm;
&tm-attrib.intel;
&tm-attrib.sparc;
&tm-attrib.general;
$FreeBSD$$FreeBSD$This document provides information for the &os;
committer community. All new committers should read this
document before they start, and existing committers are
strongly encouraged to review it from time to time.Almost all &os; developers have commit rights to one or
more repositories. However, a few developers do not, and some
of the information here applies to them as well. (For
instance, some people only have rights to work with the
Problem Report database). Please see
for more information.This document may also be of interest to members of the
&os; community who want to learn more about how the project
works.Administrative DetailsLogin Methods&man.ssh.1;, protocol 2 onlyMain Shell Hostfreefall.FreeBSD.orgsrc/ Subversion
Rootsvn+ssh://repo.FreeBSD.org/base
(see also ).doc/ Subversion
Rootsvn+ssh://repo.FreeBSD.org/doc
(see also ).ports/ Subversion
Rootsvn+ssh://repo.FreeBSD.org/ports
(see also ).Internal Mailing Listsdevelopers (technically called all-developers),
doc-developers, doc-committers, ports-developers,
ports-committers, src-developers, src-committers. (Each
project repository has its own -developers and
-committers mailing lists. Archives for these lists can
be found in the files
/local/mail/repository-name-developers-archive
and
/local/mail/repository-name-committers-archive
on the FreeBSD.org
cluster.)Core Team monthly
reports/home/core/public/monthly-reports
on the FreeBSD.org
cluster.Ports Management Team monthly
reports/home/portmgr/public/monthly-reports
on the FreeBSD.org
cluster.Noteworthy src/ SVN
Branchesstable/8 (8.X-STABLE),
stable/9 (9.X-STABLE),
stable/10 (10.X-STABLE),
head (-CURRENT)&man.ssh.1; is required to connect to the project hosts.
For more information, see .Useful links:&os;
Project Internal Pages&os;
Project Hosts&os;
Project Administrative GroupsOpenPGP Keys for &os;Cryptographic keys conforming to the
OpenPGP (Pretty Good
Privacy) standard are used by the &os; project to
authenticate committers. Messages carrying important
information like public SSH keys can be
signed with the OpenPGP key to prove that
they are really from the committer. See
PGP &
GPG: Email for the Practical Paranoid by Michael Lucas
and
for more information.Creating a KeyExisting keys can be used, but should be checked with
doc/head/share/pgpkeys/checkkey.sh
first.For those who do not yet have an
OpenPGP key, or need a new key to meet &os;
security requirements, here we show how to generate
one.Install
security/gnupg. Enter
these lines in ~/.gnupg/gpg.conf to
set minimum acceptable defaults:fixed-list-mode
keyid-format 0xlong
personal-digest-preferences SHA512 SHA384 SHA256 SHA224
default-preference-list SHA512 SHA384 SHA256 SHA224 AES256 AES192 AES CAST5 BZIP2 ZLIB ZIP Uncompressed
use-agent
verify-options show-uid-validity
list-options show-uid-validity
sig-notation issuer-fpr@notations.openpgp.fifthhorseman.net=%g
cert-digest-algo SHA512Generate a key:&prompt.user; gpg --full-gen-key
gpg (GnuPG) 2.1.8; Copyright (C) 2015 Free Software Foundation, Inc.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
Warning: using insecure memory!
Please select what kind of key you want:
(1) RSA and RSA (default)
(2) DSA and Elgamal
(3) DSA (sign only)
(4) RSA (sign only)
Your selection? 1
RSA keys may be between 1024 and 4096 bits long.
What keysize do you want? (2048) 2048
Requested keysize is 2048 bits
Please specify how long the key should be valid.
0 = key does not expire
<n> = key expires in n days
<n>w = key expires in n weeks
<n>m = key expires in n months
<n>y = key expires in n years
Key is valid for? (0) 3y
Key expires at Wed Nov 4 17:20:20 2015 MST
Is this correct? (y/N) y
GnuPG needs to construct a user ID to identify your key.
Real name: Chucky Daemon
Email address: notreal@example.com
Comment:
You selected this USER-ID:
"Chucky Daemon <notreal@example.com>"
Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? o
You need a Passphrase to protect your secret key.2048-bit keys with a three-year expiration provide
adequate protection at present (2013-12).
describes the situation in more detail.A three year key lifespan is short enough to
obsolete keys weakened by advancing computer power,
but long enough to reduce key management
problems.Use your real name here, preferably matching that
shown on government-issued ID to
make it easier for others to verify your identity.
Text that may help others identify you can be entered
in the Comment section.After the email address is entered, a passphrase is
requested. Methods of creating a secure passphrase are
contentious. Rather than suggest a single way, here are
some links to sites that describe various methods: ,
,
,
.Protect the private key and passphrase. If either the
private key or passphrase may have been compromised or
disclosed, immediately notify
accounts@FreeBSD.org and revoke the key.Committing the new key is shown in
.Kerberos and LDAP web Password for &os; ClusterThe &os; cluster requires a Kerberos password to access
certain services. The Kerberos password also serves as the
LDAP web password, since LDAP is proxying to Kerberos in the
cluster. Some of the services
which require this include:BugzillaJenkinsTo create a new Kerberos account in the &os; cluster, or to
reset a Kerberos password for an existing account using a random
password generator:&prompt.user; ssh kpasswd.freebsd.orgThis must be done from a machine outside of the &os;.org
cluster.A Kerberos password can also be set manually
by logging into freefall.FreeBSD.org and
running:&prompt.user; kpasswdUnless the Kerberos-authenticated services
of the &os;.org cluster have been used previously,
Client unknown will be shown. This
error means that the
ssh kpasswd.freebsd.org method shown above
must be used first to initialize the Kerberos account.Commit Bit TypesThe &os; repository has a number of components which, when
combined, support the basic operating system source,
documentation, third party application ports infrastructure, and
various maintained utilities. When &os; commit bits are
allocated, the areas of the tree where the bit may be used are
specified. Generally, the areas associated with a bit reflect
who authorized the allocation of the commit bit. Additional
areas of authority may be added at a later date: when this
occurs, the committer should follow normal commit bit allocation
procedures for that area of the tree, seeking approval from the
appropriate entity and possibly getting a mentor for that area
for some period of time.Committer TypeResponsibleTree Componentssrccore@src/, doc/ subject to appropriate reviewdocdoceng@doc/, ports/, src/ documentationportsportmgr@ports/Commit bits allocated prior to the development of the notion
of areas of authority may be appropriate for use in many parts
of the tree. However, common sense dictates that a committer
who has not previously worked in an area of the tree seek review
prior to committing, seek approval from the appropriate
responsible party, and/or work with a mentor. Since the rules
regarding code maintenance differ by area of the tree, this is
as much for the benefit of the committer working in an area of
less familiarity as it is for others working on the tree.Committers are encouraged to seek review for their work as
part of the normal development process, regardless of the area
of the tree where the work is occurring.Policy for Committer Activity in Other TreesAll committers may modify
base/head/share/misc/committers-*.dot,
base/head/usr.bin/calendar/calendars/calendar.freebsd,
and
ports/head/astro/xearth/files.doc committers may commit
documentation changes to src
files, such as man pages, READMEs, fortune databases,
calendar files, and comment fixes without approval from a
src committer, subject to the normal care and tending of
commits.Any committer may make changes to any other tree
with an "Approved by" from a non-mentored committer with
the appropriate bit.Committers can acquire an additional bit by the usual
process of finding a mentor who will propose them to core,
doceng, or portmgr, as appropriate. When approved, they
will be added to 'access' and the normal mentoring period
will ensue, which will involve a continuing of
Approved by for some period."Approved by" is only acceptable from non-mentored src
committers -- mentored committers can provide a "Reviewed
by" but not an "Approved by".Subversion PrimerNew committers are assumed to already be familiar with the basic
operation of Subversion. If not, start by reading the
Subversion
Book.IntroductionThe &os; source repository switched from
CVS to Subversion on May 31st, 2008. The
first real SVN commit is
r179447.The &os; doc/www repository switched
from CVS to Subversion on May 19th, 2012.
The first real SVN commit is
r38821.The &os; ports repository switched
from CVS to Subversion on July 14th, 2012.
The first real SVN commit is
r300894.Subversion can be installed from the &os; Ports
Collection by issuing these commands:&prompt.root; pkg install subversionGetting StartedThere are a few ways to obtain a working copy of the tree
from Subversion. This section will explain them.Direct CheckoutThe first is to check out directly from the main
repository. For the src tree,
use:&prompt.user; svn checkout svn+ssh://repo.freebsd.org/base/head /usr/srcFor the doc tree, use:&prompt.user; svn checkout svn+ssh://repo.freebsd.org/doc/head /usr/docFor the ports tree, use:&prompt.user; svn checkout svn+ssh://repo.freebsd.org/ports/head /usr/portsThough the remaining examples in this document are
written with the workflow of working with the
src tree in mind, the underlying
concepts are the same for working with the
doc and the ports
tree.
Ports related Subversion operations are listed in
.The above command will check out a
CURRENT source tree as
/usr/src/,
which can be any target directory on the local filesystem.
Omitting the final argument of that command causes the
working copy, in this case, to be named head,
but that can be renamed safely.svn+ssh means the
SVN protocol tunnelled over
SSH. The name of the server is
repo.freebsd.org, base
is the path to the repository, and head
is the subdirectory within the repository.If your &os; login name is different from the login
name used on the local machine, either include it in
the URL (for example
svn+ssh://jarjar@repo.freebsd.org/base/head),
or add an entry to ~/.ssh/config
in the form:Host repo.freebsd.org
User jarjarThis is the simplest method, but it is hard to tell just
yet how much load it will place on the repository.The svn diff does not require
access to the server as SVN stores a
reference copy of every file in the working copy. This,
however, means that Subversion working copies are very
large in size.Checkout from a MirrorCheck out a working copy from a mirror by
substituting the mirror's URL for
svn+ssh://repo.freebsd.org/base. This
can be an official mirror or a mirror maintained by using
svnsync.There is a serious disadvantage to this method: every
time something is to be committed, a
svn relocate to the master repository has
to be done, remembering to svn relocate
back to the mirror after the commit. Also, since
svn relocate only works between
repositories that have the same UUID, some hacking of the
local repository's UUID has to occur before it is possible
to start using it.The hassle of a local
svnsync mirror probably is not worth it
unless the network connectivity situation or other factors
demand it. If it is needed, see the end of this chapter for
information on how to set one up.RELENG_* Branches and General
LayoutIn svn+ssh://repo.freebsd.org/base,
base refers to the source tree.
Similarly, ports refers to the ports
tree, and so on. These are separate repositories with their
own change number sequences, access controls and commit
mail.For the base repository, HEAD refers to the -CURRENT
tree. For example, head/bin/ls is what
would go into /usr/src/bin/ls in a
release. Some key locations are:/head/ which corresponds to
HEAD, also known as
-CURRENT./stable/n
which corresponds to
RELENG_n./releng/n.n
which corresponds to
RELENG_n_n./release/n.n.n
which corresponds to
RELENG_n_n_n_RELEASE./vendor* is the vendor branch
import work area. This directory itself does not
contain branches, however its subdirectories do. This
contrasts with the stable,
releng and
release directories./projects and
- /user feature a branch work area,
- like in Perforce. As above, the
+ /user feature a branch work area.
+ As above, the
/user directory does not contain
branches itself.&os; Documentation Project Branches and
LayoutIn svn+ssh://repo.freebsd.org/doc,
doc refers to the repository root of
the source tree.In general, most &os; Documentation Project work will be
done within the head/ branch of the
documentation source tree.&os; documentation is written and/or translated to
various languages, each in a separate
directory in the head/
branch.Each translation set contains several subdirectories for
the various parts of the &os; Documentation Project. A few
noteworthy directories are:/articles/ contains the source
code for articles written by various &os;
contributors./books/ contains the source
code for the different books, such as the
&os; Handbook./htdocs/ contains the source
code for the &os; website.&os; Ports Tree Branches and LayoutIn svn+ssh://repo.freebsd.org/ports,
ports refers to the repository root of
the ports tree.In general, most &os; port work will be done within the
head/ branch of the ports tree which is
the actual ports tree used to install software. Some other
key locations are:/branches/RELENG_n_n_n
which corresponds to
RELENG_n_n_n
is used to merge back security updates in preparation
for a release./tags/RELEASE_n_n_n
which corresponds to
RELEASE_n_n_n
represents a release tag of the ports tree./tags/RELEASE_n_EOL
represents the end of life tag of a specific &os;
branch.Daily UseThis section will explain how to perform common day-to-day
operations with Subversion.HelpSVN has built in help documentation.
It can be accessed by typing:&prompt.user; svn helpAdditional information can be found in the
Subversion
Book.CheckoutAs seen earlier, to check out the &os; head
branch:&prompt.user; svn checkout svn+ssh://repo.freebsd.org/base/head /usr/srcAt some point, more than just HEAD
will probably be useful, for instance when merging changes
to stable/7. Therefore, it may be useful to have a partial
checkout of the complete tree (a full checkout would be very
painful).To do this, first check out the root of the
repository:&prompt.user; svn checkout --depth=immediates svn+ssh://repo.freebsd.org/baseThis will give base with all the
files it contains (at the time of writing, just
ROADMAP.txt) and empty subdirectories
for head, stable,
vendor and so on.Expanding the working copy is possible. Just change the
depth of the various subdirectories:&prompt.user; svn up --set-depth=infinity base/head
&prompt.user; svn up --set-depth=immediates base/release base/releng base/stableThe above command will pull down a full copy of
head, plus empty copies of every
release tag, every
releng branch, and every
stable branch.If at a later date merging to
7-STABLE is required, expand the working
copy:&prompt.user; svn up --set-depth=infinity base/stable/7Subtrees do not have to be expanded completely. For
instance, expanding only stable/7/sys and
then later expand the rest of
stable/7:&prompt.user; svn up --set-depth=infinity base/stable/7/sys
&prompt.user; svn up --set-depth=infinity base/stable/7Updating the tree with svn update
will only update what was previously asked for (in this
case, head and
stable/7; it will not pull down the whole
tree.Decreasing the depth of a working copy is not
possible.Anonymous CheckoutIt is possible to anonymously check out the &os;
repository with Subversion. This will give access to a
read-only tree that can be updated, but not committed back
to the main repository. To do this, use:&prompt.user; svn co https://svn.FreeBSD.org/base/head /usr/srcMore details on using Subversion this way can be found
in Using
Subversion.Updating the TreeTo update a working copy to either the latest revision,
or a specific revision:&prompt.user; svn update
&prompt.user; svn update -r12345StatusTo view the local changes that have been made to the
working copy:&prompt.user; svn statusTo show local changes and files that are out-of-date
do:&prompt.user; svn status --show-updatesEditing and Committing
- Unlike Perforce, SVN does not need to
+ SVN does not need to
be told in advance about file editing.To commit all changes in
the current directory and all subdirectories:&prompt.user; svn commitTo commit all changes in, for example,
lib/libfetch/
and
usr/bin/fetch/
in a single operation:&prompt.user; svn commit lib/libfetchusr/bin/fetchThere is also a commit wrapper for the ports tree to
handle the properties and sanity checking the
changes:&prompt.user; /usr/ports/Tools/scripts/psvn commitAdding and Removing FilesBefore adding files, get a copy of auto-props.txt
(there is also a
ports tree specific version) and add it to
~/.subversion/config according to the
instructions in the file. If you added something before
reading this, use svn rm --keep-local
for just added files, fix your config file and re-add them
again. The initial config file is created when you first
run a svn command, even something as simple as
svn help.Files are added to a
SVN repository with svn
add. To add a file named
foo, edit it, then:&prompt.user; svn add fooMost new source files should include a
$&os;$ string near the
start of the file. On commit, svn will
expand the $&os;$ string,
adding the file path, revision number, date and time of
commit, and the username of the committer. Files which
cannot be modified may be committed without the
$&os;$ string.Files can be removed with svn
remove:&prompt.user; svn remove fooSubversion does not require deleting the file before
using svn rm, and indeed complains if
that happens.It is possible to add directories with
svn add:&prompt.user; mkdir bar
&prompt.user; svn add barAlthough svn mkdir makes this easier
by combining the creation of the directory and the adding of
it:&prompt.user; svn mkdir barLike files, directories are removed with
svn rm. There is no separate command
specifically for removing directories.&prompt.user; svn rm barCopying and Moving FilesThis command creates a copy of
foo.c named bar.c,
with the new file also under version control and with the full
history of foo.c:&prompt.user; svn copy foo.cbar.cThis is usually preferred to copying the file with
cp and adding it to the repository with
svn add because this way the new file does not
inherit the original one's history.To move and rename a file:&prompt.user; svn move foo.cbar.cLog and Annotatesvn log shows revisions and commit
messages, most recent first, for files or directories. When
used on a directory, all revisions that affected the
directory and files within that directory are shown.svn annotate, or equally svn
praise or svn blame, shows
the most recent revision number and who committed that
revision for each line of a file.Diffssvn diff displays changes to the
working copy. Diffs generated by SVN are
unified and include new files by default in the diff
output.svn diff can show the changes between
two revisions of the same file:&prompt.user; svn diff -r179453:179454 ROADMAP.txtIt can also show all changes for a specific changeset.
This command shows what changes were made to the
current directory and all subdirectories in changeset
179454:&prompt.user; svn diff -c179454 .RevertingLocal changes (including additions and deletions) can be
reverted using svn revert. It does not
update out-of-date files, but just replaces them with
pristine copies of the original version.ConflictsIf an svn update resulted in a merge
conflict, Subversion will remember which files have
conflicts and refuse to commit any changes to those files
until explicitly told that the conflicts have been resolved.
The simple, not yet deprecated procedure is:&prompt.user; svn resolved fooHowever, the preferred procedure is:&prompt.user; svn resolve --accept=working fooThe two examples are equivalent. Possible values for
--accept are:working: use the version in your
working directory (which one presumes has been edited to
resolve the conflicts).base: use a pristine copy of the
version you had before svn update,
discarding your own changes, the conflicting changes,
and possibly other intervening changes as well.mine-full: use what you had
before svn update, including your own
changes, but discarding the conflicting changes, and
possibly other intervening changes as well.theirs-full: use the version that
was retrieved when you did
svn update, discarding your own
changes.Advanced UseSparse CheckoutsSVN allows
sparse, or partial checkouts of a
directory by adding to a
svn checkout.Valid arguments to
are:empty: the directory itself
without any of its contents.files: the directory and any
files it contains.immediates: the directory and any
files and directories it contains, but none of the
subdirectories' contents.infinity: anything.The --depth option applies to many
other commands, including svn commit,
svn revert, and svn
diff.Since --depth is sticky, there is a
--set-depth option for svn
update that will change the selected depth.
Thus, given the working copy produced by the previous
example:&prompt.user; cd ~/freebsd
&prompt.user; svn update --set-depth=immediates .The above command will populate the working copy in
~/freebsd with
ROADMAP.txt and empty subdirectories,
and nothing will happen when svn update
is executed on the subdirectories. However, this
command will set the depth for
head (in this case) to infinity,
and fully populate it:&prompt.user; svn update --set-depth=infinity headDirect OperationCertain operations can be performed directly on the
repository without touching the working copy. Specifically,
this applies to any operation that does not require editing
a file, including:log,
diffmkdirremove, copy,
renamepropset,
propedit,
propdelmergeBranching is very fast. This command would be
used to branch RELENG_8:&prompt.user; svn copy svn+ssh://repo.freebsd.org/base/head svn+ssh://repo.freebsd.org/base/stable/8This is equivalent to these commands
which take minutes and hours as opposed to seconds,
depending on your network connection:&prompt.user; svn checkout --depth=immediates svn+ssh://repo.freebsd.org/base
&prompt.user; cd base
&prompt.user; svn update --set-depth=infinity head
&prompt.user; svn copy head stable/8
&prompt.user; svn commit stable/8Merging with SVNThis section deals with merging code from one branch to
another (typically, from head to a stable branch).In all examples below, $FSVN
refers to the location of the &os; Subversion repository,
svn+ssh://repo.freebsd.org/base/.About Merge TrackingFrom the user's perspective, merge tracking
information (or mergeinfo) is stored in a property called
svn:mergeinfo, which is a
comma-separated list of revisions and ranges of revisions
that have been merged. When set on a file, it applies
only to that file. When set on a directory, it applies to
that directory and its descendants (files and directories)
except for those that have their own
svn:mergeinfo.It is not inherited. For
instance, stable/6/contrib/openpam/
does not implicitly inherit mergeinfo from
stable/6/, or
stable/6/contrib/.
Doing so would make partial checkouts very hard to manage.
Instead, mergeinfo is explicitly propagated down the tree.
For merging something into
branch/foo/bar/,
these rules apply:If
branch/foo/bar/
does not already have a mergeinfo record, but a direct
ancestor (for instance,
branch/foo/)
does, then that record will be propagated down to
branch/foo/bar/
before information about the current merge is
recorded.Information about the current merge will
not be propagated back up that
ancestor.If a direct descendant of
branch/foo/bar/ (for instance,
branch/foo/bar/baz/) already has
a mergeinfo record, information about the current
merge will be propagated down to it.If you consider the case where a revision changes
several separate parts of the tree (for example,
branch/foo/bar/ and
branch/foo/quux/), but you only want
to merge some of it (for example,
branch/foo/bar/), you will see that
these rules make sense. If mergeinfo was propagated up,
it would seem like that revision had also been merged to
branch/foo/quux/, when in fact it had
not been.Selecting the Source and Target Branch
When MergingMerging to stable/ branches should
originate from head/. For
example:&prompt.user; svn merge -c r123456 ^/head/ stable/11
&prompt.user; svn commit stable/11Note the sections below which outline changes to
the target location of the stable/
branch starting with
stable/10.Merges to releng/ branches should
always originate from the corresponding
stable/ branch. For example:&prompt.user; svn merge -c r123456 ^/stable/11 releng/11.0
&prompt.user; svn commit releng/11.0Committers are only permitted to commit to the
releng/ branches during a release
cycle after receiving approval from the Release
Engineering Team, after which only the Security Officer
may commit to a releng/ branch for
a Security Advisory or Errata Notice.Selecting the Source and Target for
stable/10 and NewerStarting with the stable/10
branch, all merges are
merged to and committed from the root of the
branch. All merges look like:&prompt.user; svn merge -c r123456 ^/head/ checkout
&prompt.user; svn commit checkoutNote that checkout
must be a complete checkout of the branch to which the merge
occurs.Merges to releng/ branches must
always originate from the corresponding
stable/ branch. For example:&prompt.user; svn merge -c r123456 ^/stable/10 releng/10.0Selecting the Source and Target for
stable/9 and OlderFor stable/9 and earlier,
a different strategy was used, distributing mergeinfo
around the tree so that merges could be performed without
a complete checkout. This procedure proved extremely
error-prone, with the convenience of partial checkouts for
merges significantly outweighed by the complexity of
picking mergeinfo targets. The procedure below describes this
now-obsoleted process, which should be used
only for merges prior to
stable/10.Because of mergeinfo propagation, it is important to
choose the source and target for the merge carefully to
minimise property changes on unrelated directories.The rules for selecting the merge target (the
directory where the changes are being merged to) can be
summarized:Never merge directly to a file.Never, ever merge directly to a file.Never, ever, ever merge
directly to a file.Changes to kernel code are merged to
sys/. For instance, a change to
the &man.ichwd.4; driver is merged to
sys/, not
sys/dev/ichwd/. Likewise, a
change to the TCP/IP stack is merged to
sys/, not
sys/netinet/.Changes to code under etc/
is merged at etc/, not
below it.Changes to vendor code (code in
contrib/,
crypto/ and so on) are
merged to the directory where vendor imports happen.
For instance, a change to
crypto/openssl/util/ is
merged to crypto/openssl/. This
is rarely an issue, however, since changes to vendor
code are usually merged wholesale.Changes to userland programs should as a general
rule be merged to the directory that contains the
Makefile for that program. For instance, a change to
usr.bin/xlint/arch/i386/
is merged to
usr.bin/xlint/.Changes to userland libraries should as a general
rule be merged to the directory that contains the
Makefile for that library. For instance, a change to
lib/libc/gen/ should be merged to
lib/libc/.There may be cases where it makes sense to deviate
from the rules for userland programs and libraries.
For instance, everything under
lib/libpam/ is merged to
lib/libpam/, even though the
library itself and all of the modules each have their
own Makefile.Changes to manual pages are merged to
share/man/manN/,
for the appropriate value of
N.Other changes to share/
are merged to the appropriate subdirectory and
not to share/ directly.Changes to a top-level file in the source tree
such as UPDATING or
Makefile.inc1 are merged
directly to that file rather than to the root of the
whole tree. Yes, this is an exception to the first
three rules.When in doubt, ask.If a merge changes several places at once
(for instance, changing a kernel interface and every
userland program that uses it), merge each target
separately, then commit them together. For instance, if
merging a revision that changed a kernel
API and updated all the userland bits
that used that API, merge the
kernel change to sys, and the userland bits to the
appropriate userland directories, then commit all of these
in one go.The source will almost invariably be the same as the
target. For instance, always merge
stable/7/lib/libc/ from
head/lib/libc/. The only exception
would be when merging changes to code that has moved in
the source branch but not in the parent branch. For
instance, a change to &man.pkill.1; would be merged from
bin/pkill/ in head to
usr.bin/pkill/ in stable/7.Preparing the Merge TargetBecause of the mergeinfo propagation issues described
earlier, it is very important to never merge changes
into a sparse working copy. Always use a full
checkout of the branch being merged into. For instance,
when merging from HEAD to 7, use a full checkout
of stable/7:&prompt.user; cd stable/7
&prompt.user; svn up --set-depth=infinityThe target directory must also be up-to-date and must
not contain any uncommitted changes or stray files.Identifying RevisionsIdentifying revisions to be merged is a must. If the
target already has complete mergeinfo, ask
SVN for a list:&prompt.user; cd stable/6/contrib/openpam
&prompt.user; svn mergeinfo --show-revs=eligible $FSVN/head/contrib/openpamIf the target does not have complete mergeinfo, check
the log for the merge source.MergingNow, let us start merging!The PrinciplesFor example, To merge:revision $Rin directory $target in stable branch
$Bfrom directory $source in head$FSVN is
svn+ssh://repo.freebsd.org/baseAssuming that revisions $P and $Q have
already been merged, and that the current directory is
an up-to-date working copy of stable/$B, the
existing mergeinfo looks like this:&prompt.user; svn propget svn:mergeinfo -R $target
$target - /head/$source:$P,$QMerging is done like so:&prompt.user; svn merge -c$R $FSVN/head/$source $targetChecking the results of this is possible with
svn diff.The svn:mergeinfo now looks like:&prompt.user; svn propget svn:mergeinfo -R $target
$target - head/$source:$P,$Q,$RIf the results are not exactly as shown, assistance
may be required before committing as mistakes may have
been made, or there may be something wrong with the
existing mergeinfo, or there may be a bug in
Subversion.Practical ExampleAs a practical example, consider this
scenario. The changes to netmap.4
in r238987 are to be merged from CURRENT to 9-STABLE.
The file resides in
head/share/man/man4. According
to , this is
also where to do the merge. Note that in this example
all paths are relative to the top of the svn repository.
For more information on the directory layout, see .The first step is to inspect the existing
mergeinfo.&prompt.user; svn propget svn:mergeinfo -R stable/9/share/man/man4Take a quick note of how it looks before moving on
to the next step; doing the actual merge:&prompt.user; svn merge -c r238987 svn+ssh://repo.freebsd.org/base/head/share/man/man4 stable/9/share/man/man4
--- Merging r238987 into 'stable/9/share/man/man4':
U stable/9/share/man/man4/netmap.4
--- Recording mergeinfo for merge of r238987 into
'stable/9/share/man/man4':
U stable/9/share/man/man4Check that the revision number of the merged
revision has been added. Once this is verified, the
only thing left is the actual commit.&prompt.user; svn commit stable/9/share/man/man4Merging into the Kernel
(sys/)As stated above, merging into the kernel is
different from merging in the rest of the tree. In many
ways merging to the kernel is simpler because there is
always the same merge target
(sys/).Once svn merge has been executed,
svn diff has to be run on the
directory to check the changes. This may show some
unrelated property changes, but these can be ignored.
Next, build and test the kernel, and, once the tests are
complete, commit the code as normal, making sure that
the commit message starts with Merge
r226222 from head,
or similar.Precautions Before CommittingAs always, build world (or appropriate parts of
it).Check the changes with svn diff and
svn stat. Make sure all the files that
should have been added or deleted were in fact added or
deleted.Take a closer look at any property change (marked by a
M in the second column of svn
stat). Normally, no svn:mergeinfo properties
should be anywhere except the target directory (or
directories).If something looks fishy, ask for help.CommittingMake sure to commit a top level directory to have the
mergeinfo included as well. Do not specify individual
files on the command line. For more information about
committing files in general, see the relevant section of
this primer.Vendor Imports with SVNPlease read this entire section before starting a
vendor import.Patches to vendor code fall into two
categories:Vendor patches: these are patches that have been
issued by the vendor, or that have been extracted from
the vendor's version control system, which address
issues which cannot wait until the
next vendor release.&os; patches: these are patches that modify the
vendor code to address &os;-specific issues.The nature of a patch dictates where it should be
committed:Vendor patches must be committed to the vendor
branch, and merged from there to head. If the patch
addresses an issue in a new release that is currently
being imported, it must not be
committed along with the new release: the release must
be imported and tagged first, then the patch can be
applied and committed. There is no need to re-tag the
vendor sources after committing the patch.&os; patches are committed directly to
head.Preparing the TreeIf importing for the first time after the switch to
Subversion, flattening and cleaning up the vendor tree is
necessary, as well as bootstrapping the merge history in
the main tree.FlatteningDuring the conversion from CVS to
Subversion, vendor branches were imported with the same
layout as the main tree. This means that the
pf vendor sources ended up in
vendor/pf/dist/contrib/pf. The
vendor source is best directly in
vendor/pf/dist.To flatten the pf tree:&prompt.user; cd vendor/pf/dist/contrib/pf
&prompt.user; svn mv $(svn list) ../..
&prompt.user; cd ../..
&prompt.user; svn rm contrib
&prompt.user; svn propdel -R svn:mergeinfo .
&prompt.user; svn commitThe propdel bit is necessary
because starting with 1.5, Subversion will automatically
add svn:mergeinfo to any directory
that is copied or moved. In this case, as nothing is
being merged from the deleted tree, they just get in the
way.Tags may be flattened as well (3, 4, 3.5 etc.); the
procedure is exactly the same, only changing
dist to 3.5 or
similar, and putting the svn commit
off until the end of the process.Cleaning UpThe dist tree can be cleaned up
as necessary. Disabling keyword expansion is
recommended, as it makes no sense on unmodified vendor
code and in some cases it can even be harmful.
OpenSSH, for example,
includes two files that originated with &os; and still
contain the original version tags. To do this:&prompt.user; svn propdel svn:keywords -R .
&prompt.user; svn commitBootstrapping Merge HistoryIf importing for the first time after the switch to
Subversion, bootstrap svn:mergeinfo
on the target directory in the main tree to the revision
that corresponds to the last related change to the
vendor tree, prior to importing new sources:&prompt.user; cd head/contrib/pf
&prompt.user; svn merge --record-only svn+ssh://repo.freebsd.org/base/vendor/pf/dist@180876 .
&prompt.user; svn commitImporting New SourcesWith two commits—one for the import itself and
one for the tag—this step can optionally be repeated
for every upstream release between the last import and the
current import.Preparing the Vendor SourcesUnlike in CVS where only the
needed parts were imported into the vendor tree to avoid
bloating the main tree, Subversion is able to store a
full distribution in the vendor tree. So, import
everything, but merge only what is required.A svn add is required to add any
files that were added since the last vendor import, and
svn rm is required to remove any that
were removed since. Preparing sorted lists of the
contents of the vendor tree and of the sources that are
about to be imported is recommended, to facilitate the
process.&prompt.user; cd vendor/pf/dist
&prompt.user; svn list -R | grep -v '/$' | sort >../old
&prompt.user; cd ../pf-4.3
&prompt.user; find . -type f | cut -c 3- | sort >../newWith these two files,
comm -23 ../old ../new will list
removed files (files only in old),
while comm -13 ../old ../new will
list added files only in
new.Importing into the Vendor TreeNow, the sources must be copied into
dist and
the svn add and
svn rm commands are used as
needed:&prompt.user; cd vendor/pf/pf-4.3
&prompt.user; tar cf - . | tar xf - -C ../dist
&prompt.user; cd ../dist
&prompt.user; comm -23 ../old ../new | xargs svn rm
&prompt.user; comm -13 ../old ../new | xargs svn --parents addIf any directories were removed, they will have to
be svn rmed manually. Nothing will
break if they are not, but they will remain in the
tree.Check properties on any new files. All text files
should have svn:eol-style set to
native. All binary files should have
svn:mime-type set to
application/octet-stream unless there
is a more appropriate media type. Executable files
should have svn:executable set to
*. No other properties should exist
on any file in the tree.Committing is now possible. However, it is good
practice to make sure that everything is okay by using the
svn stat and
svn diff commands.TaggingOnce committed, vendor releases are tagged for
future reference. The best and quickest way to do this
is directly in the repository:&prompt.user; svn cp svn+ssh://repo.freebsd.org/base/vendor/pf/dist svn+ssh://repo.freebsd.org/base/vendor/pf/4.3Once that is complete, svn up the
working copy of
vendor/pf
to get the new tag, although this is rarely
needed.If creating the tag in the working copy of the tree,
svn:mergeinfo results must be
removed:&prompt.user; cd vendor/pf
&prompt.user; svn cp dist 4.3
&prompt.user; svn propdel svn:mergeinfo -R 4.3Merging to Head&prompt.user; cd head/contrib/pf
&prompt.user; svn up
&prompt.user; svn merge --accept=postpone svn+ssh://repo.freebsd.org/base/vendor/pf/dist .The --accept=postpone tells
Subversion not to complain about merge
conflicts as they will be handled manually.The cvs2svn changeover occurred
on June 3, 2008. When performing vendor merges for
packages which were already present and converted by the
cvs2svn process, the command used to
merge
/vendor/package_name/dist
to
/head/package_location
(for example,
head/contrib/sendmail) must use
to
indicate the revision to merge from the
/vendor tree. For example:&prompt.user; svn checkout svn+ssh://repo.freebsd.org/base/head/contrib/sendmail
&prompt.user; cd sendmail
&prompt.user; svn merge -c r261190 ^/vendor/sendmail/dist .^ is an alias for the
repository path.If using the Zsh shell,
the ^ must be escaped with
\. This means
^/head should be
\^/head.It is necessary to resolve any merge conflicts.Make sure that any files that were added or removed in
the vendor tree have been properly added or removed in the
main tree. To check diffs against the vendor
branch:&prompt.user; svn diff --no-diff-deleted --old=svn+ssh://repo.freebsd.org/base/vendor/pf/dist --new=.The --no-diff-deleted tells
Subversion not to complain about files that are in the
vendor tree but not in the main tree. Things that
would have previously been removed before the vendor
import, like the vendor's makefiles
and configure scripts.Using CVS, once a file was off the
vendor branch, it was not able to be put back. With
Subversion, there is no concept of on or off the vendor
branch. If a file that previously had local
modifications, to make it not show up in diffs in the
vendor tree, all that has to be done is remove any
left-over cruft like &os; version tags, which is much
easier.If any changes are required for the world to build
with the new sources, make them now, and keep testing
until everything builds and runs perfectly.Committing the Vendor ImportCommitting is now possible! Everything must be
committed in one go. If done properly, the tree will move
from a consistent state with old code, to a consistent
state with new code.From ScratchImporting into the Vendor TreeThis section is an example of importing and tagging
byacc into
head.First, prepare the directory in
vendor:&prompt.user; svn co --depth immediates $FSVN/vendor
&prompt.user; cd vendor
&prompt.user; svn mkdir byacc
&prompt.user; svn mkdir byacc/distNow, import the sources into the
dist directory.
Once the files are in place, svn add
the new ones, then svn commit and tag
the imported version. To save time and bandwidth,
direct remote committing and tagging is possible:&prompt.user; svn cp -m "Tag byacc 20120115"$FSVN/vendor/byacc/dist$FSVN/vendor/byacc/20120115Merging to headDue to this being a new file, copy it for the
merge:&prompt.user; svn cp -m "Import byacc to contrib"$FSVN/vendor/byacc/dist$FSVN/head/contrib/byaccWorking normally on newly imported sources is still
possible.Reverting a CommitReverting a commit to a previous version is fairly
easy:&prompt.user; svn merge -r179454:179453 ROADMAP.txt
&prompt.user; svn commitChange number syntax, with negative meaning a reverse
change, can also be used:&prompt.user; svn merge -c -179454 ROADMAP.txt
&prompt.user; svn commitThis can also be done directly in the repository:&prompt.user; svn merge -r179454:179453 svn+ssh://repo.freebsd.org/base/ROADMAP.txtIt is important to ensure that the mergeinfo
is correct when reverting a file to permit
svn mergeinfo --eligible to work as
expected.Reverting the deletion of a file is slightly different.
Copying the version of the file that predates the deletion
is required. For example, to restore a file that was
deleted in revision N, restore version N-1:&prompt.user; svn copy svn+ssh://repo.freebsd.org/base/ROADMAP.txt@179454
&prompt.user; svn commitor, equally:&prompt.user; svn copy svn+ssh://repo.freebsd.org/base/ROADMAP.txt@179454 svn+ssh://repo.freebsd.org/baseDo not simply recreate the file
manually and svn add it—this will
cause history to be lost.Fixing MistakesWhile we can do surgery in an emergency, do not plan on
having mistakes fixed behind the scenes. Plan on mistakes
remaining in the logs forever. Be sure to check the output
of svn status and svn
diff before committing.Mistakes will happen but,
they can generally be fixed without
disruption.Take a case of adding a file in the wrong location. The
right thing to do is to svn move the file
to the correct location and commit. This causes just a
couple of lines of metadata in the repository journal, and
the logs are all linked up correctly.The wrong thing to do is to delete the file and then
svn add an independent copy in the
correct location. Instead of a couple of lines of text, the
repository journal grows an entire new copy of the file.
This is a waste.Setting up a svnsync
MirrorAvoid setting up a svnsync
mirror unless there is a very good reason for it. Such
reasons might be to support
multiple local read-only client machines, or if the network
bandwidth is limited. Starting a fresh mirror from empty
would take a very long time. Expect a minimum of 10 hours
for high speed connectivity. If international links are
involved, expect this to take four to ten times longer.A far better option is to grab a seed file. It is large
(~1GB) but will consume less network traffic and take less
time to fetch than a svnsync will. There are several ways
to do this:&prompt.user; rsync -va --partial --progress freefall:/home/peter/svnmirror-base-r179637.tbz2 .&prompt.user; rsync -va --partial --progress rsync://repoman.freebsd.org:50873/svnseed/svnmirror-base-r215629.tar.xz .&prompt.user; fetch ftp://ftp.freebsd.org/pub/FreeBSD/development/subversion/svnmirror-base-r221445.tar.xzExtract the file to somewhere like
home/svnmirror/base/.
Then, update it, so that it fetches changes since the last
revision in the archive:&prompt.user; svnsync sync file:///home/svnmirror/baseNow, set that up to run from &man.cron.8;, do
checkouts locally, set up a svnserve server for local
machines to talk to, etc.The seed mirror is set to fetch from
svn://svn.freebsd.org/base. The
configuration for the mirror is stored in
revprop 0 on the local mirror. To see
the configuration, try:&prompt.user; svn proplist -v --revprop -r 0 file:///home/svnmirror/baseUse propset to change things.Committing High-ASCII DataFiles that have high-ASCII bits are
considered binary files in SVN, so the
pre-commit checks fail and indicate that the
mime-type property should be set to
application/octet-stream. However, the
use of this is discouraged, so please do not set it. The
best way is always avoiding high-ASCII
data, so that it can be read everywhere with any text editor
but if it is not avoidable, instead of changing the
mime-type, set the fbsd:notbinary
property with propset:&prompt.user; svn propset fbsd:notbinary yes foo.dataMaintaining a Project BranchA project branch is one that is synced to head (or
another branch) is used to develop a project then commit it
back to head. In SVN,
dolphin branching is used for this. A
dolphin branch is one that diverges for a
while and is finally committed back to the original branch.
During development code migration in one direction (from
head to the branch only). No code is committed back to head
until the end. After the branch is committed back at the end,
it is dead (although a new branch with the same name can be
created after the dead one is deleted).As per https://people.FreeBSD.org/~peter/svn_notes.txt,
work that is intended to be merged back into HEAD should be
in base/projects/. If the
work is beneficial to the &os; community in some way
but not intended to be merged directly back into HEAD then
the proper location is
base/user/username/.
This
page contains further details.To create a project branch:&prompt.user; svn copy svn+ssh://repo.freebsd.org/base/head svn+ssh://repo.freebsd.org/base/projects/spifTo merge changes from HEAD back into the project
branch:&prompt.user; cd copy_of_spif
&prompt.user; svn merge svn+ssh://repo.freebsd.org/base/head
&prompt.user; svn commitIt is important to resolve any merge conflicts before
committing.Some TipsIn commit logs etc., rev 179872 is
spelled r179872 as per convention.Speeding up svn is possible by adding these entries to
~/.ssh/config:Host *
ControlPath ~/.ssh/sockets/master-%l-%r@%h:%p
ControlMaster auto
ControlPersist yesand then typingmkdir ~/.ssh/socketsChecking out a working copy with a stock Subversion client
without &os;-specific patches
(OPTIONS_SET=FREEBSD_TEMPLATE) will mean
that $FreeBSD$ tags will not
be expanded. Once the correct version has been installed,
trick Subversion into expanding them like so:&prompt.user; svn propdel -R svn:keywords .
&prompt.user; svn revert -R .This will wipe out uncommitted patches.It is possible to automatically fill the "Sponsored by"
and "MFC after" commit log fields by setting
"freebsd-sponsored-by" and "freebsd-mfc-after" fields in the
"[miscellany]" section of the
~/.subversion/config configuration file.
For example:freebsd-sponsored-by = The FreeBSD Foundation
freebsd-mfc-after = 2 weeksSetup, Conventions, and TraditionsThere are a number of things to do as a new developer.
The first set of steps is specific to committers only. These
steps must be done by a mentor for those who are not
committers.For New CommittersThose who have been given commit rights to the &os;
repositories must follow these steps.Get mentor approval before committing each of these
changes!The .ent and
.xml files mentioned below exist in
the &os; Documentation Project SVN repository at
svn+ssh://repo.FreeBSD.org/doc/.New files that do not have the
FreeBSD=%Hsvn:keywords property will be rejected
when attempting to commit them to the repository. Be sure
to read
regarding adding and removing files. Verify that
~/.subversion/config contains the
necessary auto-props entries from
auto-props.txt mentioned
there.All src commits go to
&os.current; first before being merged to &os.stable;.
The &os.stable; branch must maintain
ABI and API
compatibility with earlier versions of that branch. Do
not merge changes that break this compatibility.Steps for New CommittersAdd an Author Entitydoc/head/share/xml/authors.ent
— Add an author entity. Later steps depend on this
entity, and missing this step will cause the
doc/ build to fail. This is a
relatively easy task, but remains a good first test of
version control skills.Update the List of Developers and
Contributorsdoc/head/en_US.ISO8859-1/articles/contributors/contrib.committers.xml
—
Add an entry to the Developers section
of the Contributors
List. Entries are sorted by last name.doc/head/en_US.ISO8859-1/articles/contributors/contrib.additional.xml
— Remove the entry from the
Additional Contributors section. Entries
are sorted by first name.Add a News Itemdoc/head/share/xml/news.xml
— Add an entry. Look for the other entries that
announce new committers and follow the format. Use the
date from the commit bit approval email from
core@FreeBSD.org.Add a PGP Keydoc/head/share/pgpkeys/pgpkeys.ent
and
doc/head/share/pgpkeys/pgpkeys-developers.xml
- Add your PGP or
GnuPG key. Those who do not yet have a
key should see .&a.des.email; has written a shell script
(doc/head/share/pgpkeys/addkey.sh) to
make this easier. See the README
file for more information.Use
doc/head/share/pgpkeys/checkkey.sh to
verify that keys meet minimal best-practices
standards.After adding and checking a key, add both updated
files to source control and then commit them. Entries in
this file are sorted by last name.It is very important to have a current
PGP/GnuPG key in
the repository. The key may be required for positive
identification of a committer. For example, the
&a.admins; might need it for account recovery. A
complete keyring of FreeBSD.org users is
available for download from https://www.FreeBSD.org/doc/pgpkeyring.txt.Update Mentor and Mentee Informationbase/head/share/misc/committers-repository.dot
— Add an entry to the current committers section,
where repository is
doc, ports, or
src, depending on the commit privileges
granted.Add an entry for each additional mentor/mentee
relationship in the bottom section.Generate a Kerberos
PasswordSee to generate or
set a Kerberos for use with
other &os; services like the bug tracking database.Optional: Enable Wiki Account&os;
Wiki Account — A wiki account allows
sharing projects and ideas. Those who do not yet have an
account can follow instructions on the AboutWiki
Page to obtain one. Contact
clusteradm@FreeBSD.org if you need help
with your Wiki account.Optional: Update Wiki InformationWiki Information - After gaining access to the wiki,
some people add entries to the How We
Got Here,
Irc
Nicks, and Dogs
of FreeBSD pages.Optional: Update Ports with Personal
Informationports/astro/xearth/files/freebsd.committers.markers
and
src/usr.bin/calendar/calendars/calendar.freebsd
- Some people add entries for themselves to these files to
show where they are located or the date of their
birthday.Optional: Prevent Duplicate MailingsSubscribers to &a.svn-src-all.name;,
&a.svn-ports-all.name; or &a.svn-doc-all.name; might wish
to unsubscribe to avoid receiving duplicate copies of
commit messages and followups.For EveryoneIntroduce yourself to the other developers, otherwise
no one will have any idea who you are or what you are
working on. The introduction need not be a comprehensive
biography, just write a paragraph or two about who you
are, what you plan to be working on as a developer in
&os;, and who will be your mentor. Email this to the
&a.developers; and you will be on your way!Log into freefall.FreeBSD.org
and create a
/var/forward/user
(where user is your username)
file containing the e-mail address where you want mail
addressed to
yourusername@FreeBSD.org to be
forwarded. This includes all of the commit messages as
well as any other mail addressed to the &a.committers; and
the &a.developers;. Really large mailboxes which have
taken up permanent residence on
freefall may get truncated
without warning if space needs to be freed, so forward it
or save it elsewhere.Due to the severe load dealing with SPAM places on the
central mail servers that do the mailing list processing,
the front-end server does do some basic checks and will
drop some messages based on these checks. At the moment
proper DNS information for the connecting host is the only
check in place but that may change. Some people blame
these checks for bouncing valid email. To have these
checks turned off for your email, create a file
named ~/.spam_lover
on freefall.FreeBSD.org.Those who are developers but not committers will
not be subscribed to the committers or developers mailing
lists. The subscriptions are derived from the access
rights.MentorsAll new developers have a mentor assigned to them for
the first few months. A mentor is responsible for teaching
the mentee the rules and conventions of the project and
guiding their first steps in the developer community. The
mentor is also personally responsible for the mentee's actions
during this initial period.For committers: do not commit anything without first
getting mentor approval. Document that approval with an
Approved by: line in the commit
message.When the mentor decides that a mentee has learned the
ropes and is ready to commit on their own, the mentor
announces it with a commit to
conf/mentors. This file is in the
svnadmin branch of each
repository:srcbase/svnadmin/conf/mentorsdocdoc/svnadmin/conf/mentorsportsports/svnadmin/conf/mentorsCommit Log MessagesThis section contains some suggestions and traditions for
how commit logs are formatted.As well as including an informative message with each
commit, some additional information may be needed.This information consists of one or more lines
containing the key word or phrase, a colon, tabs for formatting,
and then the additional information.The key words or phrases are:PR:The problem report (if any) which is affected
(typically, by being closed) by this commit.
Multiple PRs may be specified on one line, separated by
commas or spaces.Submitted by:The name and e-mail address of the person
that submitted the fix; for developers, just the
username on the &os; cluster.If the submitter is the maintainer of the port
being committed, include "(maintainer)"
after the email address.Avoid obfuscating the email address of the
submitter as this adds additional work when searching
logs.Reviewed by:The name and e-mail address of the person or
people that reviewed the change; for developers,
just the username on the &os; cluster. If a
patch was submitted to a mailing list for review,
and the review was favorable, then just include
the list name.Approved by:The name and e-mail address of the person or
people that approved the change; for developers, just
the username on the &os; cluster. It is customary to
get prior approval for a commit if it is to an area of
the tree to which you do not usually commit. In
addition, during the run up to a new release all commits
must be approved by the release
engineering team.While under mentorship, get mentor approval before
the commit. Enter the mentor's username in this field,
and note that they are a mentor:Approved by: username-of-mentor(mentor)If a team approved these commits then include the
team name followed by the username of the approver in
parentheses. For example:Approved by: re (username)Obtained from:The name of the project (if any) from which
the code was obtained. Do not use this line for the
name of an individual person.MFC after:If you wish to receive an e-mail reminder to
MFC at a later date, specify the
number of days, weeks, or months after which an
MFC is planned.MFC to:If the commit should be merged to a subset of
stable branches, specify the branch names.MFC with:If the commit should be merged together with
a previous one in a single
MFC commit (for example, where
this commit corrects a bug in the previous change),
specify the corresponding revision number.Relnotes:If the change is a candidate for inclusion in
the release notes for the next release from the branch,
set to yes.Security:If the change is related to a security
vulnerability or security exposure, include one or more
references or a description of the issue. If possible,
include a VuXML URL or a CVE ID.Differential Revision:The full URL of the Phabricator review. This line
must be the last line. For example:
https://reviews.freebsd.org/D1708.Commit Log for a Commit Based on a PRThe commit is based on a patch from a PR submitted by John
Smith. The commit message PR and
Submitted by fields are filled.....
PR: 12345
Submitted by: John Smith <John.Smith@example.com>Commit Log for a Commit Needing ReviewThe virtual memory system is being changed. After
posting patches to the appropriate mailing list (in this
case, freebsd-arch) and the changes have
been approved....
Reviewed by: -archCommit Log for a Commit Needing ApprovalCommit a port, after working with
the listed MAINTAINER, who said to go ahead and
commit....
Approved by: abc (maintainer)Where abc is the account name
of the person who approved.Commit Log for a Commit Bringing in Code from
OpenBSDCommitting some code based on work done in the
OpenBSD project....
Obtained from: OpenBSDCommit Log for a Change to &os.current; with a Planned
Commit to &os.stable; to Follow at a Later Date.Committing some code which will be merged from
&os.current; into the &os.stable; branch after two
weeks....
MFC after: 2 weeksWhere 2 is the number of days,
weeks, or months after which an MFC is
planned. The weeks option may be
day, days,
week, weeks,
month, months.It is often necessary to combine these.Consider the situation where a user has submitted a PR
containing code from the NetBSD project. Looking at the PR, the
developer sees it is not an area of the tree they normally work
in, so they have the change reviewed by the
arch mailing list. Since the change is
complex, the developer opts to MFC after one
month to allow adequate testing.The extra information to include in the commit would look
something likeExample Combined Commit LogPR: 54321
Submitted by: John Smith <John.Smith@example.com>
Reviewed by: -arch
Obtained from: NetBSD
MFC after: 1 month
Relnotes: yesPreferred License for New FilesThe &os; Project suggests and uses this
text as the preferred license scheme:/*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* Copyright (c) [year] [your name]
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* [id for your version control system, if any]
*/The &os; project strongly discourages the so-called
"advertising clause" in new code. Due to the large number of
contributors to the &os; project, complying with this clause for
many commercial vendors has become difficult. If you have code
in the tree with the advertising clause, please consider
removing it. In fact, please consider using the above license
for your code.The &os; project discourages completely new licenses and
variations on the standard licenses. New licenses require the
approval of the &a.core; to reside in the
main repository. The more different licenses that are used in
the tree, the more problems that this causes to those wishing to
utilize this code, typically from unintended consequences from a
poorly worded license.Project policy dictates that code under some non-BSD
licenses must be placed only in specific sections of the
repository, and in some cases, compilation must be conditional
or even disabled by default. For example, the GENERIC kernel
must be compiled under only licenses identical to or
substantially similar to the BSD license. GPL, APSL, CDDL, etc,
licensed software must not be compiled into GENERIC.Developers are reminded that in open source, getting "open"
right is just as important as getting "source" right, as
improper handling of intellectual property has serious
consequences. Any questions or concerns should immediately be
brought to the attention of the core team.Keeping Track of Licenses Granted to the &os;
ProjectVarious software or data exist in the repositories where
the &os; project has been granted a special licence to be able
to use them. A case in point are the Terminus fonts for use
with &man.vt.4;. Here the author Dimitar Zhekov has allowed us
to use the "Terminus BSD Console" font under a 2-clause BSD
license rather than the regular Open Font License he normally
uses.It is clearly sensible to keep a record of any such
license grants. To that end, the &a.core; has decided to keep
an archive of them. Whenever the &os; project is granted a
special license we require the &a.core; to be notified. Any
developers involved in arranging such a license grant, please
send details to the &a.core; including:Contact details for people or organizations granting the
special license.What files, directories etc. in the repositories are
covered by the license grant including the revision numbers
where any specially licensed material was committed.The date the license comes into effect from. Unless
otherwise agreed, this will be the date the license was
issued by the authors of the software in question.The license text.A note of any restrictions, limitations or exceptions
that apply specifically to &os;'s usage of the licensed
material.Any other relevant information.Once the &a.core; is satisfied that all the necessary
details have been gathered and are correct, the secretary will
send a PGP-signed acknowledgement of receipt including the
license details. This receipt will be persistently archived and
serve as our permanent record of the license grant.The license archive should contain only details of license
grants; this is not the place for any discussions around
licensing or other subjects. Access to data within the license
archive will be available on request to the &a.core;.Developer RelationsWhen working directly on your own code or on code
which is already well established as your responsibility, then
there is probably little need to check with other committers
before jumping in with a commit. Working on a bug in an area of
the system which is clearly orphaned (and there are a few such
areas, to our shame), the same applies. Trying
to modify something which is clearly being actively
maintained by someone else (and it is only by watching the
repository-committers
mailing list that a developer can really get a feel for just what is and
is not) then consider sending the change to them instead, just
as a developer would have before becoming a committer. For ports,
contact the listed MAINTAINER in the
Makefile. For other parts of the
repository, if it is not clear who the active maintainer
is, it may help to scan the revision history to see who has
committed changes in the past. An example script that lists
each person who has committed to
a given file along with the number of commits each person has
made can be found at on freefall at
~eadler/bin/whodid. If queries go
unanswered or the committer otherwise indicates a lack of
interest in the area affected, go ahead and commit it.Avoid sending private emails to maintainers. Other people
might be interested in the conversation, not just the final
output.If there is any doubt about a commit for any reason at all, have
it reviewed by -hackers before committing.
Better to have it flamed then and there rather than when it is
part of the repository. If a commit does
results in controversy erupting, it may be advisable to
consider backing the change out again until the matter is
settled. Remember, with a version control system we can
always change it back.Do not impugn the intentions of others.
If they see a different solution to a problem, or even
a different problem, it is probably not because they are stupid, because
they have questionable parentage, or because they are trying to
destroy hard work, personal image, or &os;, but basically
because they have a different outlook on the world. Different
is good.Disagree honestly. Argue your position from its merits,
be honest about any shortcomings it may have, and be open to
seeing their solution, or even their vision of the problem,
with an open mind.Accept correction. We are all fallible. When you have made
a mistake, apologize and get on with life. Do not beat up
yourself, and certainly do not beat up others for your mistake.
Do not waste time on embarrassment or recrimination, just fix
the problem and move on.Ask for help. Seek out (and give) peer reviews. One of
the ways open source software is supposed to excel is in the
number of eyeballs applied to it; this does not apply if nobody
will review code.If in Doubt...When unsure about something, whether it be a
technical issue or a project convention be sure to ask. If you
stay silent you will never make progress.If it relates to a technical issue ask on the public
mailing lists. Avoid the temptation to email the individual
person that knows the answer. This way everyone will be able to
learn from the question and the answer.For project specific or administrative questions
ask, in order:Your mentor or former mentor.An experienced committer on IRC, email, etc.Any team with a "hat", as they can give you a
definitive answer.If still not sure, ask on &a.developers;.Once your question is answered, if no one pointed you to
documentation that spelled out the answer to your question,
document it, as others will have the same question.BugzillaThe &os; Project utilizes
Bugzilla for tracking bugs and change
requests. Be sure that if you commit a fix or suggestion found
in the PR database to close it. It is also considered nice if
you take time to close any PRs associated with your commits, if
appropriate.Committers with
non-&os;.org
Bugzilla accounts can have the old account merged with the
&os;.org account by
following these steps:Log in using your old account.Open new bug. Choose
Services as the Product, and
Bug Tracker as the Component.
In bug description list acounts you wish to be merged.Log in using
&os;.org account and
post comment to newly opened bug to confirm ownership. See
for more details on how to
generate or set a password for your
&os;.org account.If there are more than two accounts to merge, post
comments from each of them.You can find out more about
Bugzilla at:&os;
Problem Report Handling Guidelineshttps://www.FreeBSD.org/support.htmlPhabricatorThe &os; Project utilizes Phabricator
for code review requests. See the CodeReview
wiki page for details.Committers with
non-&os;.org
Phabricator accounts can have the old account renamed to the
&os;.org account by
following these steps:Change your Phabricator
account email to your &os;.org email.Open new bug on our bug tracker using your &os;.org account, see
for more information. Choose
Services as the Product, and
Code Review as the Component. In bug
description request that your
Phabricator account be renamed,
and provide a link to your
Phabricator user. For example,
https://reviews.freebsd.org/p/bob_example.com/Phabricator accounts cannot be
merged, please do not open a new account.Who's WhoBesides the repository meisters, there are other &os;
project members and teams whom you will probably get to know in
your role as a committer. Briefly, and by no means
all-inclusively, these are:&a.doceng;doceng is the group responsible for the documentation
build infrastructure, approving new documentation
committers, and ensuring that the &os; website and
documentation on the FTP site is up to date with respect
to the subversion tree. It is
not a conflict resolution body.
The vast majority of documentation related discussion
takes place on the &a.doc;. More details regarding the
doceng team can be found in its charter.
Committers interested in contributing to the documentation
should familiarize themselves with the Documentation
Project Primer.&a.bde.email;Bruce is the Style Police-Meister. When you do a
commit that could have been done better, Bruce will be
there to tell you. Be thankful that someone is. Bruce is
also very knowledgeable on the various standards
applicable to &os;.&a.re.members.email;These are the members of the &a.re;. This team is
responsible for setting release deadlines and controlling
the release process. During code freezes, the release
engineers have final authority on all changes to the
system for whichever branch is pending release status. If
there is something you want merged from &os.current; to
&os.stable; (whatever values those may have at any given
time), these are the people to talk to about it.Hiroki is also the keeper of the release documentation
(src/release/doc/*). If you commit a
change that you think is worthy of mention in the release
notes, please make sure he knows about it. Better still,
send him a patch with your suggested commentary.&a.so.email;&a.so; is the
&os; Security
Officer and oversees the
&a.security-officer;.&a.wollman.email;If you need advice on obscure network internals or
are not sure of some potential change to the networking
subsystem you have in mind, Garrett is someone to talk
to. Garrett is also very knowledgeable on the various
standards applicable to &os;.&a.committers;&a.svn-src-all.name;, &a.svn-ports-all.name; and
&a.svn-doc-all.name; are the mailing lists that the
version control system uses to send commit messages to.
Never send email directly
to these lists. Only send replies to this list
when they are short and are directly related to a
commit.&a.developers;All committers are subscribed to -developers. This
list was created to be a forum for the committers
community issues. Examples are Core
voting, announcements, etc.The &a.developers; is for the exclusive use of &os;
committers. To develop &os;, committers must
have the ability to openly discuss matters that will be
resolved before they are publicly announced. Frank
discussions of work in progress are not suitable for open
publication and may harm &os;.All &os; committers are expected not to
not publish or forward messages from the
&a.developers; outside the list membership without
permission of all of the authors. Violators will be
removed from the
&a.developers;, resulting in a suspension of commit
privileges. Repeated or flagrant violations may result in
permanent revocation of commit privileges.This list is not intended as a
place for code reviews or for any technical discussion.
In fact using it as such hurts the &os; Project as it
gives a sense of a closed list where general decisions
affecting all of the &os; using community are made without
being open. Last, but not least
never, never ever, email the &a.developers; and
CC:/BCC: another &os; list. Never, ever email
another &os; email list and CC:/BCC: the &a.developers;.
Doing so can greatly diminish the benefits of this
list.SSH Quick-Start GuideIf you do not wish to type your password in every time
you use &man.ssh.1;, and you use keys to
authenticate, &man.ssh-agent.1; is there for your
convenience. If you want to use &man.ssh-agent.1;, make
sure that you run it before running other applications. X
users, for example, usually do this from their
.xsession or
.xinitrc. See &man.ssh-agent.1; for
details.Generate a key pair using &man.ssh-keygen.1;. The key
pair will wind up in your
$HOME/.ssh/
directory.Only ECDSA,
Ed25519 or RSA keys
are supported.Send your public key
($HOME/.ssh/id_ecdsa.pub,
$HOME/.ssh/id_ed25519.pub, or
$HOME/.ssh/id_rsa.pub)
to the person setting you up as a committer so it can be put
into
yourlogin
in
/etc/ssh-keys/ on
freefall.Now &man.ssh-add.1; can be used for
authentication once per session. It prompts for
the private key's pass phrase, and then stores it in the
authentication agent (&man.ssh-agent.1;). Use ssh-add
-d to remove keys stored in the agent.Test with a simple remote command: ssh
freefall.FreeBSD.org ls /usr.For more information, see
security/openssh,
&man.ssh.1;, &man.ssh-add.1;, &man.ssh-agent.1;,
&man.ssh-keygen.1;, and &man.scp.1;.For information on adding, changing, or removing &man.ssh.1;
keys, see this
article.&coverity; Availability for &os; CommittersAll &os; developers can obtain access to
Coverity analysis results of all &os;
Project software. All who are interested in obtaining access to
the analysis results of the automated
Coverity runs, can sign up at Coverity
Scan.The &os; wiki includes a mini-guide for developers who are
interested in working with the &coverity; analysis reports: https://wiki.freebsd.org/CoverityPrevent.
Please note that this mini-guide is only readable by &os;
developers, so if you cannot access this page, you will have to
ask someone to add you to the appropriate Wiki access
list.Finally, all &os; developers who are going to use
&coverity; are always encouraged to ask for more details and
usage information, by posting any questions to the mailing list
of the &os; developers.The &os; Committers' Big List of RulesEveryone involved with the &os; project is expected to
abide by the Code of Conduct available from
https://www.FreeBSD.org/internal/code-of-conduct.html.
As committers, you form the public face of the project, and how
you behave has a vital impact on the public perception of it.
This guide expands on the parts of the
Code of Conduct specific to
committers.Respect other committers.Respect other contributors.Discuss any significant change
before committing.Respect existing maintainers (if listed in the
MAINTAINER field in
Makefile or in
MAINTAINER in the top-level
directory).Any disputed change must be backed out pending
resolution of the dispute if requested by a maintainer.
Security related changes may override a maintainer's wishes
at the Security Officer's discretion.Changes go to &os.current; before &os.stable; unless
specifically permitted by the release engineer or unless
they are not applicable to &os.current;. Any non-trivial or
non-urgent change which is applicable should also be allowed
to sit in &os.current; for at least 3 days before merging so
that it can be given sufficient testing. The release
engineer has the same authority over the &os.stable; branch
as outlined for the maintainer in rule #5.Do not fight in public with other committers; it looks
bad.Respect all code freezes and read the
committers and
developers mailing lists in a timely
manner so you know when a code freeze is in effect.When in doubt on any procedure, ask first!Test your changes before committing them.Do not commit to anything under the
src/contrib,
src/crypto, or
src/sys/contrib trees without
explicit approval from the respective
maintainers.As noted, breaking some of these rules can be grounds for
suspension or, upon repeated offense, permanent removal of
commit privileges. Individual members of core have the power to
temporarily suspend commit privileges until core as a whole has
the chance to review the issue. In case of an
emergency (a committer doing damage to the
repository), a temporary suspension may also be done by the
repository meisters. Only a 2/3 majority of core has the
authority to suspend commit privileges for longer than a week or
to remove them permanently. This rule does not exist to set
core up as a bunch of cruel dictators who can dispose of
committers as casually as empty soda cans, but to give the
project a kind of safety fuse. If someone is out of control, it
is important to be able to deal with this immediately rather
than be paralyzed by debate. In all cases, a committer whose
privileges are suspended or revoked is entitled to a
hearing by core, the total duration of the
suspension being determined at that time. A committer whose
privileges are suspended may also request a review of the
decision after 30 days and every 30 days thereafter (unless the
total suspension period is less than 30 days). A committer
whose privileges have been revoked entirely may request a review
after a period of 6 months has elapsed. This review policy is
strictly informal and, in all cases, core
reserves the right to either act on or disregard requests for
review if they feel their original decision to be the right
one.In all other aspects of project operation, core is a subset
of committers and is bound by the
same rules. Just because someone is in
core this does not mean that they have special dispensation to
step outside any of the lines painted here; core's
special powers only kick in when it acts as a
group, not on an individual basis. As individuals, the core
team members are all committers first and core second.DetailsRespect other committers.This means that you need to treat other committers as
the peer-group developers that they are. Despite our
occasional attempts to prove the contrary, one does not
get to be a committer by being stupid and nothing rankles
more than being treated that way by one of your peers.
Whether we always feel respect for one another or not (and
everyone has off days), we still have to
treat other committers with respect
at all times, on public forums and in private
email.Being able to work together long term is this
project's greatest asset, one far more important than any
set of changes to the code, and turning arguments about
code into issues that affect our long-term ability to work
harmoniously together is just not worth the trade-off by
any conceivable stretch of the imagination.To comply with this rule, do not send email when you
are angry or otherwise behave in a manner which is likely
to strike others as needlessly confrontational. First
calm down, then think about how to communicate in the most
effective fashion for convincing the other persons that
your side of the argument is correct, do not just blow off
some steam so you can feel better in the short term at the
cost of a long-term flame war. Not only is this very bad
energy economics, but repeated displays of
public aggression which impair our ability to work well
together will be dealt with severely by the project
leadership and may result in suspension or termination of
your commit privileges. The project leadership will take
into account both public and private communications
brought before it. It will not seek the disclosure of
private communications, but it will take it into account
if it is volunteered by the committers involved in the
complaint.All of this is never an option which the project's
leadership enjoys in the slightest, but unity comes first.
No amount of code or good advice is worth trading that
away.Respect other contributors.You were not always a committer. At one time you were
a contributor. Remember that at all times. Remember what
it was like trying to get help and attention. Do not
forget that your work as a contributor was very important
to you. Remember what it was like. Do not discourage,
belittle, or demean contributors. Treat them with
respect. They are our committers in waiting. They are
every bit as important to the project as committers.
Their contributions are as valid and as important as your
own. After all, you made many contributions before you
became a committer. Always remember that.Consider the points raised under
and apply them also to
contributors.Discuss any significant change
before committing.The repository is not where changes are
initially submitted for correctness or argued over, that
happens first in the mailing lists or by use of the
Phabricator service. The commit will only happen once
something resembling consensus has been reached. This
does not mean that permission is required before
correcting every obvious syntax error or manual page
misspelling, just that it is good to develop a feel
for when a proposed change is not quite such a no-brainer
and requires some feedback first. People really do not
mind sweeping changes if the result is something clearly
better than what they had before, they just do not like
being surprised by those changes.
The very best way of making sure that things are on the right
track is to have code reviewed by one or more other
committers.When in doubt, ask for review!Respect existing maintainers if listed.Many parts of &os; are not owned in
the sense that any specific individual will jump up and
yell if you commit a change to their area,
but it still pays to check first. One convention we use
is to put a maintainer line in the
Makefile for any package or subtree
which is being actively maintained by one or more people;
see https://www.FreeBSD.org/doc/en_US.ISO8859-1/books/developers-handbook/policies.html
for documentation on this. Where sections of code have
several maintainers, commits to affected areas by one
maintainer need to be reviewed by at least one other
maintainer. In cases where the
maintainer-ship of something is not clear,
look at the repository logs for the files
in question and see if someone has been working recently
or predominantly in that area.Other areas of &os; fall under the control of someone
who manages an overall category of &os; evolution, such as
internationalization or networking. See https://www.FreeBSD.org/administration.html
for more information on this.Any disputed change must be backed out pending
resolution of the dispute if requested by a maintainer.
Security related changes may override a maintainer's
wishes at the Security Officer's discretion.This may be hard to swallow in times of conflict (when
each side is convinced that they are in the right, of
course) but a version control system makes it unnecessary
to have an ongoing dispute raging when it is far easier to
simply reverse the disputed change, get everyone calmed
down again and then try to figure out what is the best way
to proceed. If the change turns out to be the best thing
after all, it can be easily brought back. If it turns out
not to be, then the users did not have to live with the
bogus change in the tree while everyone was busily
debating its merits. People very
rarely call for back-outs in the repository since
discussion generally exposes bad or controversial changes
before the commit even happens, but on such rare occasions
the back-out should be done without argument so that we
can get immediately on to the topic of figuring out
whether it was bogus or not.Changes go to &os.current; before &os.stable; unless
specifically permitted by the release engineer or unless
they are not applicable to &os.current;. Any non-trivial
or non-urgent change which is applicable should also be
allowed to sit in &os.current; for at least 3 days before
merging so that it can be given sufficient testing. The
release engineer has the same authority over the
&os.stable; branch as outlined in rule #5.This is another do not argue about it
issue since it is the release engineer who is ultimately
responsible (and gets beaten up) if a change turns out to
be bad. Please respect this and give the release engineer
your full cooperation when it comes to the &os.stable;
branch. The management of &os.stable; may frequently seem
to be overly conservative to the casual observer, but also
bear in mind the fact that conservatism is supposed to be
the hallmark of &os.stable; and different rules apply
there than in &os.current;. There is also really no point
in having &os.current; be a testing ground if changes are
merged over to &os.stable; immediately. Changes need a
chance to be tested by the &os.current; developers, so
allow some time to elapse before merging unless the
&os.stable; fix is critical, time sensitive or so obvious
as to make further testing unnecessary (spelling fixes to
manual pages, obvious bug/typo fixes, etc.) In other
words, apply common sense.Changes to the security branches (for example,
releng/9.3) must be approved by a
member of the &a.security-officer;, or in some cases, by a
member of the &a.re;.Do not fight in public with other committers; it looks
bad.This project has a public image to uphold and that
image is very important to all of us, especially if we are
to continue to attract new members. There will be
occasions when, despite everyone's very best attempts at
self-control, tempers are lost and angry words are
exchanged. The best thing that can be done in such cases
is to minimize the effects of this until everyone has
cooled back down. Do not air
angry words in public and do not forward private
correspondence or other private communications to public
mailing lists, mail aliases, instant messaging channels or
social media sites. What people say one-to-one is often
much less sugar-coated than what they would say in public,
and such communications therefore have no place there -
they only serve to inflame an already bad situation. If
the person sending a flame-o-gram at least had the
grace to send it privately, then have the grace to keep it
private yourself. If you feel you are being unfairly
treated by another developer, and it is causing you
anguish, bring the matter up with core rather than taking
it public. Core will do its best to play peace makers and
get things back to sanity. In cases where the dispute
involves a change to the codebase and the participants do
not appear to be reaching an amicable agreement, core may
appoint a mutually-agreeable third party to resolve the
dispute. All parties involved must then agree to be bound
by the decision reached by this third party.Respect all code freezes and read the
committers and
developers mailing list on a timely
basis so you know when a code freeze is in effect.Committing unapproved changes during a code freeze is
a really big mistake and committers are expected to keep
up-to-date on what is going on before jumping in after a
long absence and committing 10 megabytes worth of
accumulated stuff. People who abuse this on a regular
basis will have their commit privileges suspended until
they get back from the &os; Happy Reeducation Camp we
run in Greenland.When in doubt on any procedure, ask first!Many mistakes are made because someone is in a hurry
and just assumes they know the right way of doing
something. If you have not done it before, chances are
good that you do not actually know the way we do things
and really need to ask first or you are going to
completely embarrass yourself in public. There is no
shame in asking
how in the heck do I do this? We already
know you are an intelligent person; otherwise, you would
not be a committer.Test your changes before committing them.This may sound obvious, but if it really were so
obvious then we probably would not see so many cases of
people clearly not doing this. If your changes are to the
kernel, make sure you can still compile both GENERIC and
LINT. If your changes are anywhere else, make sure you
can still make world. If your changes are to a branch,
make sure your testing occurs with a machine which is
running that code. If you have a change which also may
break another architecture, be sure and test on all
supported architectures. Please refer to the
&os;
Internal Page for a list of available resources.
As other architectures are added to the &os; supported
platforms list, the appropriate shared testing resources
will be made available.Do not commit to anything under the
src/contrib,
src/crypto, and
src/sys/contrib trees without
explicit approval from the respective
maintainers.The trees mentioned above are for contributed software
usually imported onto a vendor branch. Committing
something there, even if it does not take the file off the
vendor branch, may cause unnecessary headaches for those
responsible for maintaining that particular piece of
software. Thus, unless you have
explicit approval from the maintainer
(or you are the maintainer), do not
commit there!Please note that this does not mean you should not try
to improve the software in question; you are still more
than welcome to do so. Ideally, submit your
patches to the vendor. If your changes are
&os;-specific, talk to the maintainer; they may be
willing to apply them locally. But whatever you do, do
not commit there by yourself!Contact the &a.core; if you wish to take up
maintainership of an unmaintained part of the tree.Policy on Multiple Architectures&os; has added several new architecture ports during
recent release cycles and is truly no longer an &i386; centric
operating system. In an effort to make it easier to keep
&os; portable across the platforms we support, core has
developed this mandate:
Our 32-bit reference platform is &arch.i386;, and our
64-bit reference platform is &arch.amd64;. Major design
work (including major API and ABI changes) must prove
itself on at least one 32-bit and at least one 64-bit
platform, preferably the primary reference platforms,
before it may be committed to the source tree.
The &arch.i386; and &arch.amd64; platforms were chosen
due to being more readily available to developers and as
representatives of more diverse processor and system designs -
big versus little endian, register file versus register stack,
different DMA and cache implementations, hardware page tables
versus software TLB management etc.We will continue to re-evaluate this policy as cost and
availability of the 64-bit platforms change.Developers should also be aware of our Tier Policy for
the long term support of hardware architectures. The rules
here are intended to provide guidance during the development
process, and are distinct from the requirements for features
and architectures listed in that section. The Tier rules for
feature support on architectures at release-time are more
strict than the rules for changes during the development
process.Other SuggestionsWhen committing documentation changes, use a spell checker
before committing. For all XML docs, verify that the
formatting directives are correct by running
make lint and
textproc/igor.For manual pages, run sysutils/manck
and textproc/igor
over the manual page to verify all of the cross
references and file references are correct and that the man
page has all of the appropriate MLINKs
installed.Do not mix style fixes with new functionality. A style
fix is any change which does not modify the functionality of
the code. Mixing the changes obfuscates the functionality
change when asking for differences between revisions, which
can hide any new bugs. Do not include whitespace changes with
content changes in commits to doc/ .
The extra clutter in the diffs
makes the translators' job much more difficult. Instead, make
any style or whitespace changes in separate commits that are
clearly labeled as such in the commit message.Deprecating FeaturesWhen it is necessary to remove functionality from software
in the base system, follow these guidelines
whenever possible:Mention is made in the manual page and possibly the
release notes that the option, utility, or interface is
deprecated. Use of the deprecated feature generates a
warning.The option, utility, or interface is preserved until
the next major (point zero) release.The option, utility, or interface is removed and no
longer documented. It is now obsolete. It is also
generally a good idea to note its removal in the release
notes.Privacy and ConfidentialityMost &os; business is done in public.&os; is an open project. Which
means that not only can anyone use the source code, but
that most of the development process is open to public
scrutiny.Certain sensitive matters must remain private or
held under embargo.There unfortunately cannot be complete transparency.
As a &os; developer you will have a certain degree of
privileged access to information. Consequently you are
expected to respect certain requirements for
confidentiality. Sometimes the need for confidentiality
comes from external collaborators or has a specific time
limit. Mostly though, it is a matter of not releasing
private communications.The Security Officer has sole control over the
release of security advisories.Where there are security problems that affect many
different operating systems, &os; frequently depends on
early access to be able to prepare advisories for
coordinated release. Unless &os; developers can be
trusted to maintain security, such early access will not
be made available. The Security Officer is responsible
for controlling pre-release access to information about
vulnerabilities, and for timing the release of all
advisories. He may request help under condition of
confidentiality from any developer with relevant knowledge
to prepare security fixes.Communications with Core are kept confidential for as
long as necessary.Communications to core will initially be treated as
confidential. Eventually however, most of Core's business
will be summarized into the monthly or quarterly core
reports. Care will be taken to avoid publicising any
sensitive details. Records of some particularly sensitive
subjects may not be reported on at all and will be
retained only in Core's private archives.Non-disclosure Agreements may be required for access
to certain commercially sensitive data.Access to certain commercially sensitive data may
only be available under a Non-Disclosure Agreement. The
FreeBSD Foundation legal staff must be consulted before
any binding agreements are entered into.Private communications must not be made
public without permission.Beyond the specific requirements above there is a
general expectation not to publish private communications
between developers without the consent of all parties
involved. Ask permission before forwarding a message onto
a public mailing list, or posting it to a forum or website
that can be accessed by other than the original
correspondents.Communications on project-only or restricted access
channels must be kept private.Similarly to personal communications, certain
internal communications channels, including &os; Committer
only mailing lists and restricted access IRC channels
are considered private communications. Permission is
required to publish material from these
sources.Core may approve publication.Where it is impractical to obtain permission due to
the number of correspondents or where permission to
publish is unreasonably withheld, Core may approve release
of such private matters that merit more general
publication.Support for Multiple Architectures&os; is a highly portable operating system intended to
function on many different types of hardware architectures.
Maintaining clean separation of Machine Dependent (MD) and
Machine Independent (MI) code, as well as minimizing MD code, is
an important part of our strategy to remain agile with regards
to current hardware trends. Each new hardware architecture
supported by &os; adds substantially to the cost of code
maintenance, toolchain support, and release engineering. It
also dramatically increases the cost of effective testing of
kernel changes. As such, there is strong motivation to
differentiate between classes of support for various
architectures while remaining strong in a few key architectures
that are seen as the &os; target audience.Statement of General IntentThe &os; Project targets "production quality commercial
off-the-shelf (COTS) workstation, server, and high-end
embedded systems". By retaining a focus on a narrow set of
architectures of interest in these environments, the &os;
Project is able to maintain high levels of quality, stability,
and performance, as well as minimize the load on various
support teams on the project, such as the ports team,
documentation team, security officer, and release engineering
teams. Diversity in hardware support broadens the options for
&os; consumers by offering new features and usage
opportunities (such as support for 64-bit CPUs, use in
embedded environments, etc.), but these benefits must always
be carefully considered in terms of the real-world maintenance
cost associated with additional platform support.The &os; Project differentiates platform targets into
four tiers. Each tier includes a specification of the
requirements for an architecture to be in that tier,
as well as specifying the obligations of developers with
regards to the platform. In addition, a policy is defined
regarding the circumstances required to change the tier
of an architecture.Tier 1: Fully Supported ArchitecturesTier 1 platforms are fully supported by the security
officer, release engineering, and toolchain maintenance staff.
New features added to the operating system must be fully
functional across all Tier 1 architectures for every release
(features which are inherently architecture-specific, such as
support for hardware device drivers, may be exempt from this
requirement). In general, all Tier 1 platforms must have
build and test automation support either in the FreeBSD.org cluster,
or easily available for all developers. Embedded platforms
may substitute an emulator available in the FreeBSD.org cluster
for actual hardware.Tier 1 architectures are expected to be Production Quality
with respects to all aspects of the &os; operating system,
including installation and development environments.Tier 1 architectures are expected to be completely
integrated into the source tree and have all features
necessary to produce an entire system relevant for that target
architecture. Tier 1 architectures generally have at least 6
active developers.Tier 1 architectures are expected to be fully supported by
the ports system. All the ports should build on a Tier 1
platform, or have the appropriate filters to prevent the
inappropriate ones from building there. The packaging system
must support all Tier 1 architectures. To ensure an
architecture's Tier 1 status, proponents of that architecture
must show that all relevant packages can be built on that
platform.Tier 1 embedded architectures must be able to cross-build
packages on at least one other Tier 1 architecture. The
packages must be the most relevant for the platform, but may
be a non-empty subset of those that build natively.Tier 1 architectures must be fully documented. All basic
operations need to be covered by the handbook or other
documents. All relevant integration documentation must also
be integrated into the tree, or readily available.Current Tier 1 platforms are &arch.i386; and
&arch.amd64;.Tier 2: Developmental ArchitecturesTier 2 platforms are not supported by the security officer
and release engineering teams. Platform maintainers are
responsible for toolchain support in the tree. The toolchain
maintainers are expected to work with the platform maintainers
to refine these changes. Major new toolchain components are
allowed to break support for Tier 2 architectures if the
&os;-local changes have not been incorporated upstream.
The toolchain maintainers are expected to provide prompt
review of any proposed changes and cannot block, through their
inaction, changes going into the tree. New features added to
&os; should be feasible to implement on these platforms,
but an implementation is not required before the feature may
be added to the &os; source tree. New features that may be
difficult to implement on Tier 2 architectures should provide
a means of disabling them on those architectures. The
implementation of a Tier 2 architecture may be committed to
the main &os; tree as long as it does not interfere with
production work on Tier 1 platforms, or substantially with
other Tier 2 platforms. Before a Tier 2 platform can be added
to the &os; base source tree, the platform must be able to
boot multi-user on actual hardware. Generally, there must be
at least three active developers working on the
platform.Tier 2 architectures are usually systems targeted at Tier
1 support, but that are still under development.
Architectures reaching end of life may also be moved from Tier
1 status to Tier 2 status as the availability of resources to
continue to maintain the system in a Production Quality state
diminishes. Well supported niche architectures may also be
Tier 2.Tier 2 architectures have basic support for them
integrated into the ports infrastructure. They may have cross
compilation support added, at the discretion of portmgr. Some
ports must built natively into packages if the package system
supports that architecture. If not integrated into the base
system, some external patches for the architecture for ports
must be available.Tier 2 architectures can be integrated into the &os;
handbook. The basics for how to get a system running must be
documented, although not necessarily for every single board or
system a Tier 2 architecture supports. The supported hardware
list must exist and be relatively recent. It should be
integrated into the &os; documentation.Current Tier 2 platforms are &arch.arm;, &arch.arm64;,
&arch.ia64; (through &os; 10), &arch.mips;,
&arch.pc98; (through &os; 11),
&arch.powerpc;, and &arch.sparc64;.Tier 3: Experimental ArchitecturesTier 3 platforms are not supported by the security officer
and release engineering teams. At the discretion of the
toolchain maintainers, they may be supported in the toolchain.
Tier 3 platforms are architectures in the early stages of
development, for non-mainstream hardware platforms, or which
are considered legacy systems unlikely to see broad future
use. Initial support for Tier 3 platforms is worked on
in external SCM repositories.
The transition to &os;'s subversion takes place after
the platform boots multi-user on hardware; sharing via
subversion is needed for wider exposure; and multiple
developers are actively working on the platform.
Platforms that transition to Tier 3 status may be
removed from the tree if they are no longer actively supported
by the &os; developer community at the discretion of the
release engineer.Tier 3 platforms may have ports support, either integrated
or external, but do not require it.Tier 3 platforms must have the basics documented for how
to build a kernel and how to boot it on at least one target
hardware or emulation environment. This documentation need
not be integrated into the &os; tree.Current Tier 3 platforms are &arch.riscv;.Tier 4: Unsupported ArchitecturesTier 4 systems are not supported in any form by the
project.All systems not otherwise classified into a support tier
are Tier 4 systems. The &arch.ia64; platform is transitioning
to Tier 4 status in &os; 11. The &arch.pc98; platform is
transitioning to Tier 4 status in &os; 12.Policy on Changing the Tier of an ArchitectureSystems may only be moved from one tier to another by
approval of the &os; Core Team, which shall make that
decision in collaboration with the Security Officer, Release
Engineering, and toolchain maintenance teams.Ports Specific FAQAdding a New PortHow do I add a new port?First, please read the section about repository
copies.The easiest way to add a new port is the
addport script located in the
ports/Tools/scripts directory. It
adds a port from the directory specified, determining
the category automatically from the port
Makefile. It also adds an entry to
the port's category Makefile. It
was written by &a.mharo.email;, &a.will.email;, and
&a.garga.email;. When sending questions about this
script to the &a.ports;, please also CC &a.crees.email;,
the current maintainer.Any other things I need to know when I add a new
port?Check the port, preferably to make sure it compiles
and packages correctly. This is the recommended
sequence:&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 packageThe Porters
Handbook contains more detailed
instructions.Use &man.portlint.1; to check the syntax of the
port. You do not 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 Additional
Contributors section of the &os;
Contributors List.Close the PR if the port came in as a PR. To close
a PR, change the state to Issue
Resolved and the resolution as
Fixed.Removing an Existing PortHow do I remove an existing port?First, please read the section about repository
copies. Before you remove the port, you have to verify
there are no other ports depending on it.Make sure there is no dependency on the port
in the ports collection:The port's PKGNAME appears in exactly
one line in a recent INDEX file.No other ports contains any reference
to the port's directory or PKGNAME in their
MakefilesWhen using Git,
consider using git grep, it
is much faster than grep
-r.Then, remove the port:Remove the port's files and directory with
svn remove.Remove the SUBDIR listing
of the port in the parent directory
Makefile.Add an entry to
ports/MOVED.Search for entries in
ports/security/vuxml/vuln.xml
and adjust them accordingly. In particular,
check for previous packages with the new name
which version could include the new port.Remove the port from
ports/LEGAL if it is
there.Alternatively, you can use the
rmport script, from
ports/Tools/scripts. This script
was written by &a.vd.email;. When sending questions
about this script to the &a.ports;, please also CC
&a.crees.email;, the current maintainer.Re-adding a Deleted PortHow do I re-add a deleted port?This is essentially the reverse of deleting a
port.Do not use svn add to add the
port. Follow these steps. If they are unclear, or
are not working, ask for help, do not just
svn add the port.Figure out when the port was removed. Use this
list,
or look for the port on freshports,
and then copy the last living revision of the
port:&prompt.user; cd /usr/ports/category
&prompt.user; svn cp 'svn+ssh://repo.freebsd.org/ports/head/category/portname/@XXXXXX' portnamePick the revision that is just before the
removal. For example, if the revision where it was
removed is 269874, use
269873.It is also possible to specify a date. In that
case, pick a date that is before the removal but
after the last commit to the port.&prompt.user; cd /usr/ports/category
&prompt.user; svn cp 'svn+ssh://repo.freebsd.org/ports/head/category/portname/@{YYYY-MM-DD}' portnameMake the changes necessary to get the port
working again. If it was deleted because the
distfiles are no longer available, either
volunteer to host the distfiles, or find someone
else to do so.If some files have been added, or were removed
during the resurrection process, use svn
add or svn remove to
make sure all the files in the port will be
committed.Restore the SUBDIR listing of
the port in the parent directory
Makefile, keeping the entries
sorted.Delete the port entry from
ports/MOVED.If the port had an entry in
ports/LEGAL, restore it.svn commit these changes,
preferably in one step.The addport script mentioned in
now detects when the
port to add has previously existed, and attempts to
handle all except the ports/LEGAL
step automatically.Repository CopiesWhen do we need a repository copy?When you want to add a port that is related to any
port that is already in the tree in a separate
directory, you have to do a repository copy. 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 the name of a directory
must be changed because the authors renamed their
software even though it is a descendant of a port
already in a tree.What do I need to do?With Subversion, a repo copy can be done by any
committer:Doing a repo copy:Verify that the target directory does
not exist.Use svn up to make
certain the original files, directories, and
checkout information is current.Use svn move or
svn copy to do the repo
copy.Upgrade the copied port to the new version.
Remember to add or change the
PKGNAMEPREFIX or
PKGNAMESUFFIX so there are no
duplicate ports with the same name. In some
rare cases it may be necessary to change the
PORTNAME instead of adding
PKGNAMEPREFIX or
PKGNAMESUFFIX, but this
is only done when it is really needed
— for example, using an existing port as the base
for a very similar program with a different
name, or upgrading a port to a new upstream
version which actually changes the distribution
name, like the transition from
textproc/libxml to
textproc/libxml2. In most
cases, adding or changing
PKGNAMEPREFIX or
PKGNAMESUFFIX
suffices.Add the new subdirectory to the
SUBDIR listing in the parent
directory Makefile. You
can run make checksubdirs in
the parent directory to check this.If the port changed categories, modify the
CATEGORIES line of the port's
Makefile accordinglyAdd an entry to
ports/MOVED, if you remove
the original port.Commit all changes on one commit.When removing a port:Perform a thorough check of the ports
collection for any dependencies on the old port
location/name, and update them. Running
grep on
INDEX is not enough because
some ports have dependencies enabled by
compile-time options. A full
grep -r of the ports
collection is recommended.Remove the old port and the
old SUBDIR entry.Add an entry to
ports/MOVED.After repo moves (rename
operations where a port is copied and the old
location is removed):Follow the same steps that are outlined in
the previous two entries, to activate the new
location of the port and remove the old
one.Ports FreezeWhat is a ports freeze?A ports freeze was a restricted state
the ports tree was put in before a release. It was used
to ensure a higher quality for the packages shipped with
a release. It usually lasted a couple of weeks. During
that time, build problems were fixed, and the release
packages were built. This practice is no longer used,
as the packages for the releases are built from the
current stable, quarterly branch.For more information on how to merge commits to the
quarterly branch, see .Quarterly BranchesWhat is the procedure to request authorization for
merging a commit to the quarterly branch?When doing the commit, add the branch name to the
MFH: line, for example:MFH: 2014Q1It will automatically notify the &a.ports-secteam; and
the &a.portmgr;. They will then decide if the commit can be
merged and answer with the procedure.If the commit has already been made, send an email
to the &a.ports-secteam; and the &a.portmgr; with the revision
number and a small description of why the commit needs
to be merged.Are there any changes that can be committed without
approval?The following blanket approvals are in effect:These fixes must be
tested on the quarterly branch.Fixes that do not result in a change in contents
of the resulting package. For example:pkg-descr:
WWW: URL updates (existing
404, moved or incorrect)Build, runtime or packaging fixes, if the
quarterly branch version is currently broken.Missing dependencies (detected, linked against
but not registered via
*_DEPENDS).Fixing shebangs,
stripping installed libraries and binaries, and
plist fixes.Backport of security and reliability fixes which
only result in PORTREVISION bumps
and no changes to enabled features. for example,
adding a patch fixing a buffer overflow.Adding/fixing CONFLICTS.Web Browsers, browser plugins, and their required
dependencies.No unauthorized commits can ever be made without
approval of either &a.ports-secteam; or
&a.portmgr;.What is the procedure for merging commits to the
quarterly branch?A script is provided to automate merging a specific
commit: ports/Tools/scripts/mfh.
It is used as follows:&prompt.user; /usr/ports/Tools/scripts/mfh 380362
U 2015Q1
Checked out revision 380443.
A 2015Q1/security
Updating '2015Q1/security/rubygem-sshkit':
A 2015Q1/security/rubygem-sshkit
A 2015Q1/security/rubygem-sshkit/Makefile
A 2015Q1/security/rubygem-sshkit/distinfo
A 2015Q1/security/rubygem-sshkit/pkg-descr
Updated to revision 380443.
--- Merging r380362 into '2015Q1':
U 2015Q1/security/rubygem-sshkit/Makefile
U 2015Q1/security/rubygem-sshkit/distinfo
--- Recording mergeinfo for merge of r380362 into '2015Q1':
U 2015Q1
--- Recording mergeinfo for merge of r380362 into '2015Q1/security':
G 2015Q1/security
--- Eliding mergeinfo from '2015Q1/security':
U 2015Q1/security
--- Recording mergeinfo for merge of r380362 into '2015Q1/security/rubygem-sshkit':
G 2015Q1/security/rubygem-sshkit
--- Eliding mergeinfo from '2015Q1/security/rubygem-sshkit':
U 2015Q1/security/rubygem-sshkit
M 2015Q1
M 2015Q1/security/rubygem-sshkit/Makefile
M 2015Q1/security/rubygem-sshkit/distinfo
Index: 2015Q1/security/rubygem-sshkit/Makefile
===================================================================
--- 2015Q1/security/rubygem-sshkit/Makefile (revision 380443)
+++ 2015Q1/security/rubygem-sshkit/Makefile (working copy)
@@ -2,7 +2,7 @@
# $FreeBSD$
PORTNAME= sshkit
-PORTVERSION= 1.6.1
+PORTVERSION= 1.7.0
CATEGORIES= security rubygems
MASTER_SITES= RG
Index: 2015Q1/security/rubygem-sshkit/distinfo
===================================================================
--- 2015Q1/security/rubygem-sshkit/distinfo (revision 380443)
+++ 2015Q1/security/rubygem-sshkit/distinfo (working copy)
@@ -1,2 +1,2 @@
-SHA256 (rubygem/sshkit-1.6.1.gem) = 8ca67e46bb4ea50fdb0553cda77552f3e41b17a5aa919877d93875dfa22c03a7
-SIZE (rubygem/sshkit-1.6.1.gem) = 135680
+SHA256 (rubygem/sshkit-1.7.0.gem) = 90effd1813363bae7355f4a45ebc8335a8ca74acc8d0933ba6ee6d40f281a2cf
+SIZE (rubygem/sshkit-1.7.0.gem) = 136192
Index: 2015Q1
===================================================================
--- 2015Q1 (revision 380443)
+++ 2015Q1 (working copy)
Property changes on: 2015Q1
___________________________________________________________________
Modified: svn:mergeinfo
Merged /head:r380362
Do you want to commit? (no = start a shell) [y/n]At that point, the script will either open a shell
for you to fix things, or open your text editor with the
commit message all prepared and then commit the
merge.The script assumes that you can connect to
repo.FreeBSD.org with
SSH directly, so if your
local login name is different than your &os; cluster
account, you need a few lines in your
~/.ssh/config:Host repo.freebsd.org # Can be *.freebsd.org
User freebsd-loginThe script is also able to merge more than one
revision at a time. If there have been other updates
to the port since the branch was created that have not
been merged because they were not security related.
Add the different revisions in the order
they were committed on the
mfh command line.
The new commit log message will contain the combined
log messages from all the original commits. These
messages must be edited to show
what is actually being done with the new
commit.&prompt.user; /usr/ports/Tools/scripts/mfh r407208 r407713 r407722 r408567 r408943 r410728The mfh script can also take an optional first
argument, the branch where the merge is being done.
Only the latest quarterly branch is supported, so
specifying the branch is discouraged. To be safe, the
script will give a warning if the quarterly branch is
not the latest:&prompt.user; /usr/ports/Tools/scripts/mfh 2016Q1 r407208 r407713
/!\ The latest branch is 2016Q2, do you really want to commit to 2016Q1? [y/n]Creating a New CategoryWhat is the procedure for creating a new
category?Please see
Proposing a New Category in the Porter's
Handbook. Once that procedure has been followed and the
PR has been assigned to the &a.portmgr;, it is their
decision whether or not to approve it. If they do, it
is their responsibility to:Perform any needed moves. (This only applies
to physical categories.)Update the VALID_CATEGORIES
definition in
ports/Mk/bsd.port.mk.Assign the PR back to you.What do I need to do to implement a new physical
category?Upgrade each moved port's
Makefile. Do not connect the
new category to the build yet.To do this, you will need to:Change the port's
CATEGORIES (this was the
point of the exercise, remember?) The new
category is listed
first. This will help to
ensure that the PKGORIGIN is
correct.Run a make describe.
Since the top-level
make index that you will be
running in a few steps is an iteration of
make describe over the entire
ports hierarchy, catching any errors here will
save you having to re-run that step later
on.If you want to be really thorough, now
might be a good time to run
&man.portlint.1;.Check that the PKGORIGINs are
correct. The ports system uses each port's
CATEGORIES entry to create its
PKGORIGIN, which is used to
connect installed packages to the port directory
they were built from. If this entry is wrong,
common port tools like &man.pkg.version.1; and
&man.portupgrade.1; fail.To do this, use the
chkorigin.sh tool:
env
PORTSDIR=/path/to/ports
sh -e
/path/to/ports/Tools/scripts/chkorigin.sh.
This will check every port in
the ports tree, even those not connected to the
build, so you can run it directly after the move
operation. Hint: do not forget to look at the
PKGORIGINs of any slave ports of
the ports you just moved!On your own local system, test the proposed
changes: first, comment out the
SUBDIR entries in the old ports'
categories' Makefiles; then
enable building the new category in
ports/Makefile. Run
make checksubdirs in the affected
category directories to check the
SUBDIR entries. Next, in the
ports/
directory, run make index. This
can take over 40 minutes on even modern systems;
however, it is a necessary step to prevent problems
for other people.Once this is done, you can commit the updated
ports/Makefile to connect the
new category to the build and also commit the
Makefile changes for the old
category or categories.Add appropriate entries to
ports/MOVED.Update the documentation by modifying:the list
of categories in the Porter's
Handbookdoc/en_US.ISO8859-1/htdocs/ports.
Note that these are now displayed by sub-groups,
as specified in
doc/en_US.ISO8859-1/htdocs/ports/categories.descriptions.(Note: these are in the docs, not the ports,
repository). If you are not a docs committer, you
will need to submit a PR for this.Only once all the above have been done, and no
one is any longer reporting problems with the new
ports, should the old ports be deleted from their
previous locations in the repository.It is not necessary to manually update the
ports web
pages to reflect the new category. This is
done automatically via the change to
en_US.ISO8859-1/htdocs/ports/categories
and the automated rebuild of
INDEX.What do I need to do to implement a new virtual
category?This is much simpler than a physical category. Only
a few modifications are needed:the list
of categories in the Porter's
Handbooken_US.ISO8859-1/htdocs/ports/categoriesMiscellaneous QuestionsHow do I know if my port is building correctly or
not?The packages are built multiple times each week. If
a port fails, the maintainer will receive an email from
pkg-fallout@FreeBSD.org.Reports for all the package builds (official,
experimental, and non-regression) are aggregated at
pkg-status.FreeBSD.org.I added a new port. Do I need to add it to the
INDEX?No. The file can either be generated by running
make index, or a pre-generated
version can be downloaded with
make fetchindex.Are there any other files I am not allowed to
touch?Any file directly under ports/,
or any file under a subdirectory that starts with an
uppercase letter (Mk/,
Tools/, etc.). In particular, the
&a.portmgr; is very protective of
ports/Mk/bsd.port*.mk so do not
commit changes to those files unless you want to face
their wrath.What is the proper procedure for updating the
checksum for a port distfile when the file changes
without a version change?When the checksum for a distribution file is updated
due to the author updating the file without changing the
port revision, the commit message includes a
summary of the relevant diffs between the original and
new distfile to ensure that the distfile has not been
corrupted or maliciously altered. If the current
version of the port has been in the ports tree for a
while, a copy of the old distfile will usually be
available on the ftp servers; otherwise the author or
maintainer should be contacted to find out why the
distfile has changed.How can an experimental test build of the ports tree
(exp-run) be requested?An exp-run must be completed before patches with a
significant ports impact are committed. The patch can
be against the ports tree or the base system.Full package builds will be done with the patches
provided by the submitter, and the submitter is required
to fix detected problems (fallout)
before commit.Go to the Bugzilla
new PR page.Select the product your patch is about.Fill in the bug report as normal. Remember to
attach the patch.If at the top it says Show Advanced
Fields click on it. It will now say
Hide Advanced Fields. Many new
fields will be available. If it already says
Hide Advanced Fields, no need to do
anything.In the Flags section, set the
exp-run one to ?.
As for all other fields, hovering the mouse over any
field shows more details.Submit. Wait for the build to run.&a.portmgr; will replies with a possible
fallout.Depending on the fallout:If there is no fallout, the procedure stops
here, and the change can be committed, pending
any other approval required.If there is fallout, it
must be fixed, either
by fixing the ports directly in the ports
tree, or adding to the submitted
patch.When this is done, go back to step 6
saying the fallout was fixed and wait for
the exp-run to be run again. Repeat as long
as there are broken ports.Issues Specific to Developers Who Are Not
CommittersA few people who have access to the &os; machines do not
have commit bits. Almost all of this document will apply to
these developers as well (except things specific to commits and
the mailing list memberships that go with them). In particular,
we recommend that you read:Administrative
DetailsConventionsGet your mentor to add you to the
Additional Contributors
(doc/en_US.ISO8859-1/articles/contributors/contrib.additional.xml),
if you are not already listed there.Developer
RelationsSSH Quick-Start
GuideThe &os; Committers' Big List
of RulesInformation About &ga;As of December 12, 2012, &ga; was enabled on the
&os; Project website to collect anonymized usage statistics
regarding usage of the site. The information collected is
valuable to the &os; Documentation Project, to
identify various problems on the &os; website.&ga; General PolicyThe &os; Project takes visitor privacy very
seriously. As such, the &os; Project website honors the
Do Not Track header before
fetching the tracking code from Google. For more information,
please see the
&os;
Privacy Policy.&ga; access is not arbitrarily
allowed — access must be requested, voted on by the
&a.doceng;, and explicitly granted.Requests for &ga; data must include a specific purpose.
For example, a valid reason for requesting access would be
to see the most frequently used web browsers when
viewing &os; web pages to ensure page rendering speeds are
acceptable.Conversely, to see what web browsers are most
frequently used (without stating
why) would be rejected.All requests must include the timeframe for which the data
would be required. For example, it must be explicitly stated
if the requested data would be needed for a timeframe covering
a span of 3 weeks, or if the request would be one-time
only.Any request for &ga; data without a clear, reasonable
reason beneficial to the &os; Project will be
rejected.Data Available Through &ga;A few examples of the types of &ga; data available
include:Commonly used web browsersPage load timesSite access by languageMiscellaneous QuestionsWhy are trivial or cosmetic changes to files on a
vendor branch a bad idea?From now on, every new vendor release of that file
will need to have patches merged in by hand.From now on, every new vendor release of that file
will need to have patches
verified by hand.How do I add a new file to a branch?To add a file onto a branch, simply checkout or update
to the branch you want to add to and then add the file
using the add operation as you normally would. This works
fine for the doc and
ports trees. The
src tree uses SVN and requires more
care because of the mergeinfo
properties. See the
Subversion Primer
for details on how to perform an MFC.How do I access people.FreeBSD.org to
put up personal or project information?people.FreeBSD.org is
the same as freefall.FreeBSD.org.
Just create a public_html directory.
Anything you place in that directory will automatically be
visible under https://people.FreeBSD.org/.Where are the mailing list archives stored?The mailing lists are archived under
/local/mail on freefall.FreeBSD.org.I would like to mentor a new committer. What process
do I need to follow?See the New
Account Creation Procedure document on the
internal pages.Benefits and Perks for &os; ComittersRecognitionRecognition as a competent software engineer is the
longest lasting value. In addition, getting a chance to work
with some of the best people that every engineer would dream
of meeting is a great perk!FreeBSD Mall&os; committers can get a free 4-CD or DVD set at
conferences from
&os; Mall,
Inc..IRCIn addition, developers may request a cloaked hostmask
for their account on the Freenode IRC network in the form
of
freebsd/developer/freefall
name or
freebsd/developer/NickServ
name. To request a cloak, send an email to
&a.irc.email; with your requested hostmask and NickServ
account name.Gandi.netGandi provides website hosting, cloud computing, domain
registration, and X.509 certificate services.Gandi offers an E-rate discount to all &os; developers.
Send mail to non-profit@gandi.net using your
@freebsd.org mail address, and indicate
your Gandi handle.
Index: head/en_US.ISO8859-1/books/dev-model/book.xml
===================================================================
--- head/en_US.ISO8859-1/books/dev-model/book.xml (revision 51678)
+++ head/en_US.ISO8859-1/books/dev-model/book.xml (revision 51679)
@@ -1,2515 +1,2497 @@
%chapters;
]>
A project model for the FreeBSD ProjectNiklasSaers2002-2005Niklas Saers1.5October, 2014Remove mention of GNATS which is no longer
used by the project.1.4September, 2013Remove mention of CVS and CVSup which are no
longer used by the project.1.3October, 2012Remove hats held by specific people, these
are documented elsewhere.1.2April, 2005Update one year of changes, replace statistics with those of 20041.1July, 2004First update within the FreeBSD tree1.0December 4th, 2003Ready for commit to FreeBSD Documentation0.7April 7th, 2003Release for review by the Documentation team0.6March 1st, 2003Incorporated corrections noted by
interviewees and reviewers0.5February 1st, 2003Initial review by interviewees$FreeBSD$Foreword
Up until now, the FreeBSD project has released a number of
described techniques to do different parts of work. However,
a project model summarising how the project is structured is needed
because of the increasing amount of project members.
This goes hand-in-hand with Brooks' law that adding
another person to a late project will make it later
since it will increase the communication needs .
A project model
is a tool to reduce the communication needs.
This paper
will provide such a project model and is donated to the
FreeBSD Documentation project where it can evolve together with
the project so that it can at any point in time reflect the way
the project works. It is based on .
I would like to thank the following people for taking the time
to explain things that were unclear to me and for proofreading
the document.Andrey A. Chernov ache@freebsd.orgBruce A. Mah bmah@freebsd.orgDag-Erling Smørgrav des@freebsd.orgGiorgos Keramidaskeramida@freebsd.orgIngvil Hovig ingvil.hovig@skatteetaten.noJesper Holckjeh.inf@cbs.dkJohn Baldwin jhb@freebsd.orgJohn Polstra jdp@freebsd.orgKirk McKusick mckusick@freebsd.orgMark Linimon linimon@freebsd.orgMarleen DevosNiels Jørgenssennielsj@ruc.dkNik Clayton nik@freebsd.orgPoul-Henning Kamp phk@freebsd.orgSimon L. Nielsen simon@freebsd.orgOverview
A project model is a means to reduce the communications overhead in
a project. As shown by , increasing the
number of project participants increases the communication in the
project exponentionally. FreeBSD has during the past few years
increased both its mass of active users and committers, and the
communication in the project has risen accordingly. This project
model will serve to reduce this overhead by providing an up-to-date
description of the project.
During the Core elections in 2002, Mark Murray stated
I am opposed to a long rule-book, as that satisfies
lawyer-tendencies, and is counter to the technocentricity that
the project so badly needs..
This project model is not meant to be a tool to
justify creating impositions for developers, but as a tool to
facilitate coordination.
It is meant as a
description of the project, with an overview of how the different
processes are executed.
It is an introduction to how the FreeBSD
project works.
The FreeBSD project model will be described as of
July 1st, 2004. It is based on the Niels Jørgensen's paper
,
FreeBSD's official documents,
discussions on FreeBSD mailing lists and interviews with
developers.
After providing definitions of terms used, this document will outline
the organisational structure (including role descriptions and
communication lines),
discuss the methodology model and after presenting the
tools used for process control, it will present the defined
processes. Finally it will outline major sub-projects of the
FreeBSD project.
, Section 1.2 and 1.3
give the vision and the architectural guidelines for the
project. The vision is To produce the best UNIX-like
operating system package possible, with due respect to the
original software tools ideology as well as usability,
performance and stability. The architectural
guidelines help determine whether a problem that someone wants
to be solved is within the scope of the project
DefinitionsActivity
An activity is an element of work performed
during the course of a project .
It has an output and
leads towards an outcome.
Such an output can either be an input to another
activity or a part of the process' delivery.
Process
A process is a series of activities
that lead towards a particular outcome. A process can
consist of one or more sub-processes. An example of a process is software
design.
Hat
A hat is synonymous with role. A hat has
certain responsibilities in a process and for the process
outcome. The hat executes activities. It is well defined what
issues the hat should be contacted about by the project
members and people outside the project.
Outcome
An outcome is the final output of the process.
This is synonymous with deliverable, that is defined as
any measurable, tangible, verifiable outcome, result or
item that must be produced to complete a project or part of a
project. Often used more narrowly in reference to an external
deliverable, which is a deliverable that is subject to approval
by the project sponsor or customer by .
Examples of
outcomes are a piece of software, a decision made or a
report written.
FreeBSD
When saying FreeBSD we will mean the BSD
derivative UNIX-like operating system
FreeBSD, whereas when saying the FreeBSD
Project we will mean the project organisation.
Organisational structure
While no-one takes ownership of FreeBSD, the FreeBSD
organisation is divided into core, committers and contributors
and is part of the FreeBSD community that lives around it.
Number of committers has been determined by going through
CVS logs from January 1st, 2004 to December 31st, 2004 and
contributors by going through the list of contributions and
problem reports.
The main resource in the FreeBSD community is its developers: the
committers and contributors. It is with their contributions that the
project can move forward. Regular developers are referred to as contributors.
As by January 1st, 2003, there are an estimated 5500
contributors on the project.
Committers are developers with the privilege of being able to
commit changes. These are usually the
most active developers who are willing to
spend their time not only integrating their own code but
integrating code submitted by the developers who
do not have this privilege. They are also the developers who elect
the core team, and they have access to closed discussions.
The project can be grouped into four distinct separate parts,
and most developers will focus their involvement in one
part of FreeBSD.
The four parts
are kernel development, userland development, ports and
documentation. When referring to the base system, both
kernel and userland is meant.
This split changes our triangle to look like this:
Number of committers per area has been determined by going through
CVS logs from January 1st, 2004 to December 31st, 2004.
Note that many committers work in multiple
areas, making the total number higher than the real number
of committers. The total number of committers at that
time was 269.
Committers fall into three
groups: committers who are only concerned with one area of
the project (for instance file systems), committers who
are involved only with one sub-project
and committers who commit to different parts
of the code, including sub-projects.
Because some committers work on different parts, the total
number in the committers section of the triangle is higher than
in the above triangle.
The kernel is the main building block of FreeBSD. While
the userland applications are protected against faults in
other userland applications, the entire system is
vulnerable to errors in the kernel. This, combined with the
vast amount of dependencies in the kernel and that it is not easy to
see all the consequences of a kernel change, demands
developers with a relative full understanding of the
kernel. Multiple development efforts in the kernel also
requires a closer coordination than userland applications do.
The core utilities, known as userland, provide the interface that identifies
FreeBSD, both user interface, shared libraries and external interfaces to
connecting clients. Currently, 162 people are involved in userland
development and maintenance, many being maintainers for
their own part of the code.
Maintainership will
be discussed in the section.
Documentation is handled by
and includes all documents surrounding the
FreeBSD project, including the web pages. There were during 2004 101
people making commits to the FreeBSD Documentation Project.
Ports is the collection of meta-data that is needed to make
software packages build correctly on FreeBSD. An example of a port
is the port for the web-browser Mozilla. It contains
information about where to fetch the source, what patches to
apply and how, and how the package should be installed on the
system. This allows automated tools to fetch, build and
install the package. As of this writing, there are more than
12600 ports available.
Statistics are generated by counting the number of
entries in the file fetched by portsdb by April 1st, 2005.
portsdb is a part of the port sysutils/portupgrade.
, ranging
from web servers to games, programming languages and most of the
application types that are in use on modern computers.
Ports will be discussed further in the section
.
Methodology modelDevelopment model
There is no defined model for how people write code in
FreeBSD. However, Niels Jørgenssen has suggested a model of
how written code is integrated into the project.
The development release is the FreeBSD-CURRENT
("-CURRENT") branch and the production release
is the FreeBSD-STABLE branch ("-STABLE")
.
This is a model for one change, and shows that after
coding, developers seek community review and
try integrating it with their own systems. After integrating the change
into the development release, called FreeBSD-CURRENT, it is tested
by many users and developers in the FreeBSD community. After it
has gone through enough testing, it is merged into the production
release, called FreeBSD-STABLE. Unless each stage is finished
successfully, the developer needs to go back and make
modifications in the code and restart the process. To integrate a
change with either -CURRENT or -STABLE is called making a commit.
Jørgensen found that most FreeBSD developers work
individually, meaning that this model is used in parallel by
many developers on the different ongoing development efforts. A
developer can also be working on multiple changes, so that while
he is waiting for review or people to test one or more of his
changes, he may be writing another change.
As each commit represents an increment, this is a massively
incremental model. The commits are in fact so frequent that
during one year
The period from January 1st, 2004 to December 31st, 2004 was
examined to find this number.
, 85427 commits were made, making a daily average of 233
commits.
Within the code bracket in Jørgensen's
figure, each programmer has his own working style and follows his
own development models. The bracket could very well have been
called development as it includes requirements
gathering and analysis, system and detailed design,
implementation and verification. However, the only
output from these stages is the source code or system documentation.
From a stepwise model's perspective (such as the waterfall
model), the other brackets can be seen as further verification
and system integration. This system integration is also important
to see if a change is accepted by the community. Up until the
code is committed, the developer is free to choose how much to
communicate about it to the rest of the project. In order for
-CURRENT to work as a buffer (so that bright ideas that had some
undiscovered drawbacks can be backed out) the minimum time a
commit should be in -CURRENT before merging it to -STABLE is 3
days. Such a merge is referred to as an MFC (Merge From Current).
It is important to notice the word change. Most
commits do not contain radical new features, but are maintenance
updates.
The only exceptions from this model are security fixes and
changes to features that are deprecated in the -CURRENT branch.
In these cases, changes can be committed directly to the -STABLE branch.
In addition to many people working on the project, there are
many related projects to the FreeBSD Project. These are either
projects developing brand new features,
sub-projects or projects whose outcome is incorporated into
FreeBSD
For instance, the development of the Bluetooth stack started
as a sub-project until it was deemed stable enough to be
merged into the -CURRENT branch. Now it is a part of the core
FreeBSD system.
.
These projects fit into the FreeBSD Project just like regular
development efforts: they produce code that is integrated with
the FreeBSD Project. However, some of them (like Ports and
Documentation) have the privilege of being applicable to both
branches or commit directly to both -CURRENT and -STABLE.
There is no standards to how design should be done, nor is
design collected in a centralised repository.
The main design is that of 4.4BSD.
According to Kirk McKusick, after 20 years of developing
UNIX operating systems, the interfaces are for the most part
figured out. There is therefore no need for much
design. However, new applications of the system and new hardware leads to
some implementations being more beneficial than those that
used to be preferred. One example is the introduction of web
browsing that made the normal TCP/IP connection a short
burst of data rather than a steady stream over a longer
period of time.
As design is a part of the Code bracket in
Jørgenssen's model, it is up to every developer or
sub-project how this should be done.
Even if the design should be stored in a central repository,
the output from the design stages would be of limited use as
the differences of methodologies would make them poorly if at
all interoperable. For the overall design of the project, the
project relies on the sub-projects to negotiate fit interfaces
between each other rather than to dictate interfacing.
Release branches
The releases of FreeBSD is best illustrated by a tree with many
branches where each major branch represents a major
version. Minor versions are represented by branches of the
major branches.
In the following release tree, arrows that follow one-another
in a particular direction
represent a branch. Boxes with full lines and diamonds represent official
releases. Boxes with dotted lines represent the development
branch at that time. Security branches are represented by ovals.
Diamonds differ from boxes in that they
represent a fork, meaning a place where a branch splits into two
branches where one of the branches becomes a sub-branch.
For example,
at 4.0-RELEASE the 4.0-CURRENT branch split into 4-STABLE and
5.0-CURRENT. At 4.5-RELEASE, the branch forked off a security
branch called RELENG_4_5.
The latest -CURRENT version
is always referred to as -CURRENT, while the latest -STABLE
release is always referred to as -STABLE. In this figure,
-STABLE refers to 4-STABLE while -CURRENT refers to
5.0-CURRENT following 5.0-RELEASE.
A major release is always made from the -CURRENT branch.
However, the -CURRENT branch does not need to fork at that point in time,
but can focus on stabilising. An example of this is that following
3.0-RELEASE, 3.1-RELEASE was also a continuation of the
-CURRENT-branch, and -CURRENT did not become a true development
branch until this version was released and the 3-STABLE branch
was forked. When
-CURRENT returns to becoming a development branch, it can only be
followed by a major release. 5-STABLE is predicted to be forked
off 5.0-CURRENT at around 5.3-RELEASE. It is not until
5-STABLE is forked that the development branch will be branded 6.0-CURRENT.
A minor release is made from the -CURRENT branch
following a major release, or from the -STABLE branch.
Following and including, 4.3-RELEASE
The first release this actually happened for was 4.5-RELEASE,
but security branches were at the same time created for
4.3-RELEASE and 4.4-RELEASE.
, when a minor release has been made, it becomes a security
branch. This is meant for organisations that do not want
to follow the -STABLE branch and the potential new/changed features it
offers, but instead require an absolutely stable environment, only
updating to implement security updates.
There is a terminology
overlap with respect to the word "stable", which leads to some
confusion. The -STABLE branch is still a
development branch, whose goal is to be
useful for most people.
If it is never acceptable for a system to get changes that
are not announced at the time it is deployed,
that system should run a security branch.
Each update to a security branch
is called a patchlevel. For every security
enhancement that is done, the patchlevel number is increased,
making it easy for people tracking the branch to see what
security enhancements they have implemented. In cases where there
have been especially serious security flaws, an entire new release
can be made from a security branch. An example of this is
4.6.2-RELEASE.
Model summary
To summarise, the development model of FreeBSD can be seen as
the following tree:
The tree of the FreeBSD development with ongoing development
efforts and continuous integration.
The tree symbolises the release versions with major versions
spawning new main branches and minor versions being versions of
the main branch. The top branch is the -CURRENT branch where all
new development is integrated, and the -STABLE branch is the
branch directly below it.
Clouds of development efforts hang over the project
where developers use the development models they see fit. The
product of their work is then integrated into -CURRENT where it
undergoes parallel debugging and is finally merged from -CURRENT into
-STABLE. Security fixes are merged from -STABLE to the security branches.
Hats
Many committers have a special area of responsibility. These
roles are called hats.
These hats can
be either project roles, such as public relations officer, or
maintainer for a certain area of the
code. Because this is a project where people give voluntarily of
their spare time, people with assigned hats are not always
available. They must therefore appoint a deputy that can perform
the hat's role in his or her absence. The other option is to have
the role held by a group.
Many of these hats are not formalised. Formalised hats have a
charter stating the exact purpose of the hat along with its
privileges and responsibilities. The writing of such charters is
a new part of the project, and has thus yet to be completed for
all hats. These hat descriptions are not such a formalisation,
rather a summary of the role with links to the charter where
available and contact addresses.
General HatsContributor
A Contributor contributes to the FreeBSD project either as a
developer, as an author, by sending problem reports, or in
other ways contributing to the progress of the project. A
contributor has no special privileges in the FreeBSD project.
Committer
A person who has the required privileges to add his code or documentation to the
repository.
A committer has made a commit within the past 12 months.
An active committer is a committer
who has made an average of one commit per month during that time.
It is worth noting that there are no technical barriers to prevent
someone, once having gained commit privileges to the main- or a sub-project, to make commits in
parts of that project's source the committer did not specifically get
permission to modify. However, when wanting to make
modifications to parts a committer has not been involved in
before, he/she should read the logs to see what has happened
in this area before, and also read the MAINTAINER file to see if
the maintainer of this part has any special requests on how
changes in the code should be made
Core Team
The core team is elected by the committers from the pool of committers
and serves as the board of directors of the FreeBSD project. It
promotes active contributors to committers, assigns people to
well-defined hats, and is the final arbiter of decisions involving
which way the project should be heading.
As by July 1st, 2004, core consisted of 9 members.
Elections are held every two years.
Maintainership
Maintainership means that that person is responsible for
what is allowed to go into that area of the code and has the
final say should disagreements over the code occur. This
involves proactive work aimed at stimulating
contributions and reactive work in reviewing commits.
With the FreeBSD
source comes the MAINTAINERS file that contains a one-line
summary of how each maintainer would like contributions to be
made. Having this notice and contact information
enables developers to focus on the development effort rather
than being stuck in a slow correspondence should the maintainer
be unavailable for some time.
If the maintainer is unavailable for an unreasonably long period
of time, and other people do a significant amount of work,
maintainership may be switched without the maintainer's approval.
This is based on the stance that maintainership should be
demonstrated, not declared.
Maintainership of a particular piece of code is a hat that
is not held as a group.
Official Hats
The official hats in the FreeBSD Project are hats that are more
or less formalised and mainly administrative roles. They have
the authority and responsibility for their area. The following
illustration shows the responsibility lines. After this follows
a description of each hat, including who it is held by.
All boxes consist of groups of committers, except for the
dotted boxes where the holders are not necessarily committers. The
flattened circles are sub-projects and consist of both
committers and non-committers of the main project.
Documentation project manager
architect is responsible for
defining and following up documentation goals for the
committers in the Documentation project.
Hat held by:
The DocEng team doceng@FreeBSD.org.
The
DocEng Charter.
Postmaster
The Postmaster is responsible for mail being correctly
delivered to the committers' email address. He is also
responsible for ensuring that the mailing lists work and
should take measures against possible disruptions of mail
such as having troll-, spam- and virus-filters.
Hat currently held by:
the Postmaster Team postmaster@FreeBSD.org.
Release Coordination
The responsibilities of the Release Engineering Team are
Setting, publishing and following a release schedule for
official releases
Documenting and formalising release engineering procedures
Creation and maintenance of code branches
Coordinating with the Ports and Documentation teams
to have an updated set of packages and documentation
released with the new releases
Coordinating with the Security team so that pending
releases are not affected by recently disclosed vulnerabilities.
Further information about the development process is
available in the section.
Hat held by:
the Release Engineering team re@FreeBSD.org.
The
Release Engineering Charter.
Public Relations & Corporate Liaison
The Public Relations & Corporate Liaison's
responsibilities are:
Making press statements when happenings that are
important to the FreeBSD Project happen.
Being the official contact person for corporations that
are working close with the FreeBSD Project.
Take steps to promote FreeBSD within both the Open Source
community and the corporate world.
Handle the freebsd-advocacy mailing list.
This hat is currently not occupied.
Security Officer
The Security Officer's main responsibility is to
coordinate information exchange with others in the
security community and in the FreeBSD project.
The Security Officer is also responsible for taking action
when security problems are reported and promoting proactive
development behavior when it comes to security.
Because of the fear that information about
vulnerabilities may leak out to people with malicious
intent before a patch is available, only the Security
Officer, consisting of an officer, a deputy and two
members, receive sensitive
information about security issues. However, to create or
implement a patch, the Security Officer has the Security
Officer Team security-team@FreeBSD.org to
help do the work.
Source Repository Manager
The Source Repository Manager is the only one who is allowed
to directly modify the repository without using the
tool.
It is his/her
responsibility to ensure that technical problems that arise in the
repository are resolved quickly. The source repository
manager has the authority to back out commits if this is
necessary to resolve a SVN technical problem.
Hat held by:
the Source Repository Manager clusteradm@FreeBSD.org.
Election Manager
The Election Manager is responsible for the
process. The manager
is responsible for running and maintaining the election
system, and is the final authority should minor unforeseen
events happen in the election process. Major unforeseen
events have to be discussed with the
Hat held only during elections.
Web site Management
The Web site Management hat is responsible for coordinating
the rollout of updated web pages on mirrors around the world,
for the overall structure of the primary web site and the
system it is running upon. The management needs to
coordinate the content with
and acts as
maintainer for the www tree.
Hat held by:
the FreeBSD Webmasters www@FreeBSD.org.
Ports Manager
The Ports Manager acts as a liaison between
and the core project, and
all requests from the project should go to the ports manager.
Hat held by:
the Ports Management Team portmgr@FreeBSD.org.
The
Portmgr charter.
Standards
The Standards hat is responsible for ensuring that FreeBSD
complies with the standards it is committed to , keeping up to date
on the development of these standards and notifying
FreeBSD developers of important changes that allows them to take a
proactive role and decrease the time between a standards
update and FreeBSD's compliancy.
Hat currently held by:
Garrett Wollman wollman@FreeBSD.org.
Core Secretary
The Core Secretary's main responsibility is to write drafts to
and publish the final Core Reports. The secretary also keeps
the core agenda, thus ensuring that no balls are dropped
unresolved.
Hat currently held by: &a.matthew.email;.
Bugmeister
The Bugmeister is responsible for ensuring that the
maintenance database is in working order, that the entries
are correctly categorised and that there are no invalid entries.
Hat currently held by:
the Bugmeister Team bugmeister@FreeBSD.org.
Donations Liaison Officer
The task of
the donations liaison officer is to match
the developers with needs with people or
organisations willing to make a
donation. The Donations Liaison Charter is
available
here
Hat held by:
the Donations Liaison Office donations@FreeBSD.org.
Admin
(Also called FreeBSD Cluster Admin)
The admin team consists of the
people responsible for administrating the
computers that the project relies on for
its distributed work and communication to
be synchronised. It consists mainly of those
people who have physical access to the
servers.
Hat held by:
the Admin team admin@FreeBSD.org.
Process dependent hatsReport originator
The person originally responsible for
filing a Problem Report.
Bugbuster
A person who will either find the right
person to solve the problem, or close the PR if
it is a duplicate or otherwise
not an interesting one.
Mentor
A mentor is a committer who takes it upon him/her to
introduce a new committer to the project, both in terms of
ensuring the new committers setup is valid,
that the new committer knows the available tools required in
his/her work and that the
new committer knows what is expected of him/her in terms of
behavior.
Vendor
The person(s) or organisation whom
external code comes from and whom patches are sent to.
Reviewers
People on the mailing list where the request
for review is posted.
Processes
The following section will describe the defined project
processes. Issues that are not handled by these processes happen
on an ad-hoc basis based on what has been customary to do in
similar cases.
Adding new and removing old committers
The Core team has the responsibility of giving and removing
commit privileges to contributors. This can only be done
through a vote on the core mailing list.
The ports and documentation sub-projects can give commit
privileges to people working on these projects, but have to
date not removed such privileges.
Normally a contributor is recommended to core by a
committer. For contributors or outsiders to contact
core asking to be a committer is not well thought of
and is usually rejected.
If the area of particular interest for the developer
potentially overlaps with other committers' area of
maintainership, the opinion of those maintainers is
sought. However, it is frequently this committer that
recommends the developer.
When a contributor is given committer status, he is
assigned a mentor. The committer who recommended the
new committer will, in the general case, take it upon
himself to be the new committers mentor.
When a contributor is given his commit bit, a -signed email is sent
from either ,
or nik@freebsd.org to both
admins@freebsd.org, the assigned mentor, the new committer and
core confirming the approval of a new account. The mentor then
gathers a password line, public key and PGP key from the
new committer and sends them to . When the new account is created, the
mentor activates the commit bit and guides the new committer
through the rest of the initial process.
When a contributor sends a piece of code, the receiving
committer may choose to recommend that the contributor is
given commit privileges. If he recommends this to core,
they will vote on this recommendation. If they vote in
favour, a mentor is assigned the new committer and the new
committer has to email his details to the administrators
for an account to be created. After this, the new
committer is all set to make his first commit. By
tradition, this is by adding his name to the committers list.
Recall that a committer is considered to be someone who
has committed code during the past 12
months. However, it is not until after 18 months of inactivity
have passed
that commit privileges are eligible to be revoked.
There are, however, no
automatic procedures for doing this.
For reactions concerning commit privileges not triggered by
time, see section 1.5.8.
When Core decides to clean up the committers list, they
check who has not made a commit for the past 18 months.
Committers who have not done so have their commit
bits revoked.
It is also possible for committers to request that their commit
bit be retired if for some reason they are no longer going
to be actively committing to the project. In this case, it can also
be restored at a later time by core, should the committer ask.
Roles in this process:
Committing code
The committing of new or modified code is one of the most
frequent processes in the FreeBSD project and will usually
happen many times a day. Committing of code can only be done
by a committer. Committers commit either code
written by themselves, code submitted to them or code
submitted through a problem
report.
When code is written by the developer that is non-trivial, he
should seek a code review from the community. This
is done by sending mail to the relevant list asking for
review. Before submitting the code for review, he should
ensure it compiles correctly with the entire tree and that all
relevant tests run. This is called pre-commit
test. When contributed code is received, it should be
reviewed by the committer and tested the same way.
When a change is committed to a part of the source that
has been contributed from an outside
,
the maintainer should
ensure that the patch is contributed back to the
vendor. This is in line with the open source
philosophy and
makes it easier to stay in sync with outside projects
as the patches do not have to be reapplied every time a
new release is made.
After the code has been available for review and no further
changes are necessary, the code is committed into the
development branch, -CURRENT.
If the change applies for
the -STABLE branch or the other branches as well, a
Merge From Current ("MFC") countdown is
set by the committer. After the number of days the
committer chose when setting the MFC have passed, an email
will automatically be
sent to the committer reminding him to commit it to the -STABLE
branch (and possibly security branches as well). Only security
critical changes should be merged to security branches.
Delaying the commit to -STABLE and other branches allows for
parallel debugging where the committed code is
tested on a wide range of configurations. This makes changes
to -STABLE to contain fewer faults and thus giving the branch
its name.
When a committer has written a piece of code and
wants to commit it, he first needs to determine if it is
trivial enough to go in without prior review or if it should
first be reviewed by the developer community. If the code is
trivial or has been reviewed and the committer is not the
maintainer, he should consult the maintainer before
proceeding.
If the code is contributed by an outside vendor, the
maintainer should create a patch that is sent back to the
vendor. The code is then committed and the deployed by
the users. Should they find problems with the code, this
will be reported and the committer can go back to writing
a patch. If a vendor is affected, he can choose to
implement or ignore the patch.
The difference when a contributor makes a code contribution is
that he submits the code through the Bugzilla
interface. This report is picked up by the maintainer who
reviews the code and commits it.
Hats included in this process are:
Core election
Core elections are held at least every two years.
The first Core election was held September 2000
Nine core members are elected. New elections are held if
the number of core members drops below seven. New elections can
also be held should at least 1/3 of the active committers demand this.
When an election is to take place, core announces this at
least 6 weeks in advance, and appoints an election manager to
run the elections.
Only committers can be elected into core. The candidates need
to submit their candidacy at least one week before the
election starts, but can refine their statements until the
voting starts. They are
presented in the candidates
list. When writing their election statements, the candidates
must answer a few standard questions submitted by the election manager.
During elections, the rule that a committer must have
committed during the 12 past months is followed strictly.
Only these committers are eligible to vote.
When voting, the committer may vote once in support of up to
nine nominees. The voting is done over a period of four weeks
with reminders being posted on developers
mailing list that is available to all committers.
The election results are released one week after the election
ends, and the new core team takes office one week after the
results have been posted.
Should there be a voting tie, this will be resolved by
the new, unambiguously elected core members.
Votes and candidate statements are archived, but the archives
are not publicly available.
Core announces the election and selects an election
manager. He prepares the elections, and when ready,
candidates can announce their candidacies through
submitting their statements. The committers then vote.
After the vote is over, the election results are
announced and the new core team takes office.
Hats in core elections are:
Development of new features
Within the project there are sub-projects that are working on
new features. These projects are generally done by one person
.
Every project is free to
organise development as it sees fit. However, when the project
is merged to the -CURRENT branch it must follow the project
guidelines. When the code has been well tested in the
-CURRENT branch and deemed stable enough and relevant
to the -STABLE branch, it is merged to the -STABLE branch.
The requirements of the project are given by developer
wishes, requests from the community in terms of direct
requests by mail, Problem Reports, commercial funding for the development
of features, or contributions by the scientific community.
The wishes that come within the responsibility of a developer
are given to that developer who prioritises his time between
the request and his wishes. A common way to do this is maintain
a TODO-list maintained by the project. Items that do not come within
someone's responsibility are collected on TODO-lists unless someone
volunteers to take the responsibility. All
requests, their distribution and follow-up are
handled by the tool.
Requirements analysis happens in two ways. The requests that
come in are discussed on mailing lists, both within the main
project and in the sub-project that the request belongs to or is
spawned by the request. Furthermore, individual developers on
the sub-project will evaluate the feasibility of the requests
and determine the prioritisation between them. Other than archives
of the discussions that have taken place, no outcome is created
by this phase that is merged into the main project.
As the requests are prioritised by the individual developers on
the basis of doing what they find interesting, necessary or are
funded to do, there is no overall strategy or prioritisation of
what requests to regard as requirements and following up their
correct implementation. However, most developers have some
shared vision of what issues are more important, and they can
ask for guidelines from the release engineering team.
The verification phase of the project is two-fold. Before
committing code to the current-branch, developers request their
code to be reviewed by their peers. This review is for the most
part done by functional testing, but also code review is
important. When the code is committed to the branch, a broader
functional testing will happen, that may trigger further code
review and debugging should the code not behave as
expected. This second verification form may be regarded as
structural verification.
Although the sub-projects themselves may write formal
tests such as unit tests, these are usually not collected by the main
project and are usually removed before the code is committed to
the current branch.
More and more tests are however performed when
building the system (make
world). These tests are however a very new
addition and no systematic framework for these
tests have yet been created.
Maintenance
It is an advantage to the project to for each area of the source
have at least one person that knows this area well.
Some parts of the code have designated
maintainers. Others have de-facto maintainers, and some
parts of the system do not have
maintainers.
The maintainer is usually a person from the sub-project that
wrote and integrated the code, or someone who has ported it from
the platform it was written for.
sendmail and named are examples of code that has been merged
from other platforms.
The maintainer's job is to make sure the code is in sync with the
project the code comes from if it is contributed code, and apply patches
submitted by the community or write fixes to issues that are
discovered.
The main bulk of work that is put into the FreeBSD project is
maintenance.
has made a figure
showing the life cycle of changes.
Here development release refers to the -CURRENT
branch while production release refers to the
-STABLE branch. The pre-commit test is the
functional testing by peer developers when asked to do so or
trying out the code to determine the status of the sub-project.
Parallel debugging is the functional testing
that can trigger more review, and debugging when the code is
included in the -CURRENT branch.
As of this writing, there were 269 committers in the
project. When they commit a change to a branch, that constitutes
a new release. It is very common for users in the community to
track a particular branch. The immediate existence of a new
release makes the changes widely available right away and allows
for rapid feedback from the community. This also gives the
community the response time they expect on issues that are of
importance to them. This makes the community more engaged, and
thus allows for more and better feedback that again spurs more
maintenance and ultimately should create a better product.
Before making changes to code in parts of the tree
that has a history unknown to the committer, the
committer is required to read the commit logs to see why
certain features are implemented the way they are in
order not to make mistakes that have previously either been
thought through or resolved.
Problem reporting
Before &os; 10, &os; included a problem reporting tool called
send-pr. Problems include bug reports,
feature requests, feature enhancements and notices of new versions
of external software that are included in the project.
Although send-pr is available, users and developers are encouraged
to submit issues using our
problem report form.
Problem reports are sent to an email address where it
is inserted into the Problem Reports maintenance database. A
classifies the problem and sends it to the
correct group or maintainer within the project. After someone
has taken responsibility for the report, the report is being
analysed. This analysis includes verifying the problem and
thinking out a solution for the problem. Often feedback is
required from the report originator or even from the FreeBSD
community. Once a patch for the problem is made, the
originator may be asked to try it out. Finally, the working patch
is integrated into the project, and documented if
applicable. It there goes through the regular maintenance
cycle as described in section .
These are the states a problem report can be in:
open, analyzed, feedback, patched, suspended and closed. The
suspended state is for when further progress is not possible
due to the lack of information or for when the task would require
so much work that nobody is working on it at the moment.
A problem is reported by the report originator. It is
then classified by a bugbuster and handed to the correct
maintainer. He verifies the problem and discusses the
problem with the originator until he has enough
information to create a working patch. This patch is then
committed and the problem report is closed.
The roles included in this process are:
.
Reacting to misbehavior has a
number of rules that committers should follow. However, it
happens that these rules are broken. The following rules exist
in order to be able to react to misbehavior. They specify what
actions will result in how long a suspension the committer's
commit privileges.
Committing during code freezes without the approval of the
Release Engineering team - 2 days
Committing to a security branch without approval - 2 days
Commit wars - 5 days to all participating parties
Impolite or inappropriate behavior - 5 days
For the suspensions to be efficient, any single core member can
implement a suspension before discussing it on the core
mailing list. Repeat offenders can, with a 2/3 vote by core,
receive harsher penalties, including permanent removal of
commit privileges. (However, the latter is always viewed as a last
resort, due to its inherent tendency to create controversy). All
suspensions are posted to the
developers
mailing list, a list available to committers only.
It is important that you cannot be suspended for making
technical errors. All penalties come from breaking social etiquette.
Hats involved in this process:
Release engineering
The FreeBSD project has a Release Engineering team with a
principal release engineer that is responsible for creating releases
of FreeBSD that can be brought out to the user community via the
net or sold in retail outlets. Since FreeBSD is available on multiple
platforms and releases for the different architectures are made
available at the same time, the team has one person in charge of
each architecture. Also, there are roles in the team responsible
for coordinating quality assurance efforts, building a package
set and for having an updated set of documents.
When referring to the release engineer,
a representative for the release engineering team is
meant.
When a release is coming, the FreeBSD project changes shape
somewhat. A release schedule is made containing feature- and
code-freezes, release of interim releases and the final
release. A feature-freeze means no new features are allowed to
be committed to the branch without the release engineers'
explicit consent. Code-freeze means no changes to the code (like
bugs-fixes) are allowed to be committed without the release
engineers explicit consent. This feature- and code-freeze is
known as stabilising. During the release process, the release
engineer has the full authority to revert to older versions of
code and thus "back out" changes should he find that the changes
are not suitable to be included in the release.
There are three different kinds of releases:
.0 releases are the first release of a major
version. These are branched of the -CURRENT branch
and have a significantly longer release engineering
cycle due to the unstable nature of the -CURRENT branch
.X releases are releases of the -STABLE
branch. They are scheduled to come out every 4 months.
.X.Y releases are security releases that follow
the .X branch. These come out only when sufficient
security fixes have been merged since the last
release on that branch. New features are rarely
included, and the security team is far more
involved in these than in regular releases.
For releases of the -STABLE-branch, the release process starts 45
days before the anticipated
release date. During the first phase, the first 15 days, the
developers merge what changes they have had in -CURRENT
that they want to have in the release to the release
branch. When this period is over, the code enters a 15
day code freeze in which only bug fixes, documentation updates,
security-related fixes and minor device driver changes are
allowed. These changes must be approved by the release engineer
in advance. At the beginning of the last 15 day period a release
candidate is created for widespread testing. Updates are less
likely to be allowed during this period, except for important
bug fixes and security updates. In this final period, all
releases are considered release candidates. At the end of the
release process, a release is created with the new version
number, including binary distributions on web sites and the
creation of a CD-ROM images. However, the release is not
considered "really released" until a -signed message stating
exactly that, is sent to the mailing list freebsd-announce; anything
labelled as a "release" before that may well be in-process and
subject to change before the PGP-signed message is sent.
Many commercial vendors use these images to create
CD-ROMs that are sold in retail outlets.
.
The releases of the -CURRENT-branch (that is, all releases that
end with .0) are very similar, but with twice as
long timeframe. It starts 8 weeks prior to the release with
announcement of the release time line. Two weeks into the
release process, the feature freeze is initiated and performance
tweaks should be kept to a minimum. Four weeks prior to the
release, an official beta version is made available. Two weeks
prior to release, the code is officially branched into a new
version. This version is given release candidate status, and as
with the release engineering of -STABLE, the code freeze of the
release candidate is
hardened. However, development on the main development branch
can continue. Other than these differences, the release
engineering processes are alike.
.0 releases go into their own branch and are aimed
mainly at early adopters. The branch then goes through a period
of stabilisation, and it is not until the
decides the demands to stability have been satisfied that
the branch becomes -STABLE and -CURRENT targets the next major
version. While this for the majority has been with .1 versions,
this is not a demand.
Most releases are made when a given date that has been deemed a
long enough time since the previous release comes. A target is
set for having major releases every 18 months and minor
releases every 4 months.
The user community has made it very clear that security and
stability cannot be sacrificed by self-imposed deadlines and
target release dates.
For slips of time not to become too long with regards to security
and stability issues,
extra discipline is required when committing changes to -STABLE.
These are the stages in the release engineering
process. Multiple release candidates may be created until
the release is deemed stable enough to be released.
Tools
The major support tools for supporting the development process are
- Perforce, Bugzilla, Mailman, and OpenSSH. These are externally
+ Bugzilla, Mailman, and OpenSSH. These are externally
developed tools and are commonly used in the open source world.
Subversion (SVN)Subversion (SVN)
is a system to handle multiple versions of text files and
tracking who committed what changes and why. A project lives
within a repository and different versions are
considered different branches.
Bugzilla
Bugzilla is a maintenance database consisting of a set of tools to track bugs at a
central site. It supports the bug tracking process for sending
and handling bugs as well as querying and updating the database
and editing bug reports. The project uses its
web interface to send
Problem Reports to the
projects central Bugzilla server. The committers also have web and
command-line clients.
Mailman
Mailman is a program that automates the
management of mailing lists. The FreeBSD Project uses it to run
16 general lists, 60 technical lists, 4 limited lists and 5 lists
with CVS commit logs. It is
also used for many mailing lists set up and used by other people
and projects in the FreeBSD community. General lists are lists
for the general public, technical lists are mainly for the
development of specific areas of interest, and closed lists
are for internal communication not intended for the general
public. The majority of all the communication in the project goes
through these 85 lists
, Appendix C.
-
-
- Perforce
-
- Perforce is a commercial software configuration management
- system developed by Perforce
- Systems that is available on over 50 operating systems. It
- is a collection of clients built around the Perforce server
- that contains the central file repository and
- tracks the operations done upon it. The clients are both
- clients for accessing the repository and administration of
- its configuration.
-
-
-
-
-
-
Pretty Good Privacy
Pretty Good Privacy, better known as PGP, is a cryptosystem
using a public key architecture to allow people to digitally
sign and/or encrypt information in order to ensure secure
communication between two parties. A signature is used when
sending information out many recipients, enabling them to verify
that the information has not been tampered with before they
received it. In the FreeBSD Project this is the primary means of
ensuring that information has been written by the person who
claims to have written it, and not altered in transit.
Secure Shell
Secure Shell is a standard for securely logging into a remote system
and for executing commands on the remote system. It allows
other connections, called tunnels, to be established and
protected between the two involved systems. This standard
exists in two primary versions, and only version two is used
for the FreeBSD Project. The most common implementation of the
standard is OpenSSH that is a part of the project's main distribution.
Since its source is updated more often than FreeBSD releases,
the latest version is also available in the ports tree.
Sub-projects
Sub-projects are formed to reduce the amount of communication
needed to coordinate the group of developers. When a problem
area is sufficiently isolated, most communication would be
within the group focusing on the problem, requiring less
communication with the groups they communicate with than were
the group not isolated.
The Ports Subproject
A port is a set of meta-data and patches that
are needed to fetch, compile and install correctly an external piece of
software on a FreeBSD system. The amount of ports have grown
at a tremendous rate, as shown by the following figure.
is taken from
the FreeBSD web site. It shows the number of ports
available to FreeBSD in the period 1995 to 2005. It looks
like the curve has first grown exponentionally, and then
since the middle of 2001 grown linearly.
As the external software described by the port often is under
continued development, the amount of work required to maintain
the ports is already large, and increasing. This has led to
the ports part of the FreeBSD project gaining a more empowered
structure, and is more and more becoming a sub-project of the
FreeBSD project.
Ports has its own core team with the
as its leader, and this
team can appoint committers without FreeBSD Core's
approval. Unlike in the FreeBSD Project, where a lot of maintenance
frequently is rewarded with a commit bit, the ports sub-project
contains many active maintainers that are not committers.
Unlike the main project, the ports tree is not branched. Every
release of FreeBSD follows the current ports collection and has thus
available updated information on where to find programs and
how to build them. This, however, means that a port that makes
dependencies on the system may need to have variations
depending on what version of FreeBSD it runs on.
With an unbranched ports repository
it is not possible to guarantee that any port
will run on anything other than -CURRENT and -STABLE, in
particular older, minor releases. There is neither the infrastructure
nor volunteer time needed to guarantee this.
For efficiency of communication, teams depending on Ports,
such as the release engineering team, have their own ports liaisons.
The FreeBSD Documentation Project
The FreeBSD Documentation project was started January 1995. From
the initial group of a project leader, four team leaders and 16
members, they are now a total of 44 committers. The
documentation mailing list has just under 300 members,
indicating that there is quite a large community around it.
The goal of the Documentation project is to provide good and
useful documentation of the FreeBSD project, thus making it
easier for new users to get familiar with the system and
detailing advanced features for the users.
The main tasks in the Documentation project are to work on
current projects in the FreeBSD Documentation Set,
and translate the documentation to other languages.
Like the FreeBSD Project, documentation is split in the same
branches. This is done so that there is always an updated
version of the documentation for each version. Only
documentation errors are corrected in the security branches.
Like the ports sub-project, the Documentation project can
appoint documentation committers without FreeBSD Core's approval.
.
The Documentation project has a primer. This is used both to
introduce new project members to the standard tools and
syntaxes and acts as a reference when working on the project.
ReferencesFrederick P.Brooks19751995Pearson Education Limited0201835959Addison-Wesley Pub CoThe Mythical Man-MonthEssays on Software Engineering, Anniversary Edition (2nd Edition)NiklasSaers2003A project model for the FreeBSD ProjectCandidatus Scientiarum thesishttp://niklas.saers.com/thesisNielsJørgensen2001Putting it All in the TrunkIncremental Software Development in the FreeBSD Open Source Projecthttp://www.dat.ruc.dk/~nielsj/research/papers/freebsd.pdfProject Management Institute19962000Project Management Institute1-880410-23-0Project Management InstituteNewtown SquarePennsylvaniaUSAPMBOK GuideA Guide to the Project Management Body of Knowledge,
2000 Edition2002The FreeBSD ProjectCore Bylawshttps://www.freebsd.org/internal/bylaws.html2002The FreeBSD Documentation ProjectFreeBSD Developer's Handbookhttps://www.freebsd.org/doc/en_US.ISO8859-1/books/developers-handbook/2002The FreeBSD ProjectCore team election 2002http://election.uk.freebsd.org/candidates.htmlDag-ErlingSmørgravHitenPandya2002The FreeBSD Documentation ProjectThe FreeBSD Documentation ProjectProblem Report Handling Guidelineshttps://www.freebsd.org/doc/en/articles/pr-guidelines/article.htmlDag-ErlingSmørgrav2002The FreeBSD Documentation ProjectThe FreeBSD Documentation ProjectWriting FreeBSD Problem Reportshttps://www.freebsd.org/doc/en/articles/problem-reports/article.html2001The FreeBSD Documentation ProjectThe FreeBSD Documentation ProjectCommitters Guidehttps://www.freebsd.org/doc/en/articles/committers-guide/article.htmlMurrayStokely2002The FreeBSD Documentation ProjectThe FreeBSD Documentation ProjectFreeBSD Release Engineeringhttps://www.freebsd.org/doc/en_US.ISO8859-1/articles/releng/article.htmlThe FreeBSD Documentation ProjectFreeBSD Handbookhttps://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook2002The FreeBSD Documentation ProjectThe FreeBSD Documentation ProjectContributors to FreeBSDhttps://www.freebsd.org/doc/en_US.ISO8859-1/articles/contributors/article.html2002The FreeBSD ProjectThe FreeBSD ProjectCore team elections 2002http://election.uk.freebsd.org2002The FreeBSD ProjectThe FreeBSD ProjectCommit Bit Expiration Policy2002/04/06 15:35:30https://www.freebsd.org/internal/expire-bits.html2002The FreeBSD ProjectThe FreeBSD ProjectNew Account Creation Procedure2002/08/19 17:11:27https://www.freebsd.org/internal/new-account.html2002The FreeBSD Documentation ProjectThe FreeBSD Documentation ProjectFreeBSD DocEng Team Charter2003/03/16 12:17https://www.freebsd.org/internal/doceng.htmlGregLehey2002Greg LeheyGreg LeheyTwo years in the trenchesThe evolution of a software projecthttp://www.lemis.com/grog/In-the-trenches.pdf
Index: head/en_US.ISO8859-1/htdocs/administration.xml
===================================================================
--- head/en_US.ISO8859-1/htdocs/administration.xml (revision 51678)
+++ head/en_US.ISO8859-1/htdocs/administration.xml (revision 51679)
@@ -1,533 +1,515 @@
]>
&title;$FreeBSD$
Introduction
This page lists teams, groups and individuals within the
FreeBSD project with designated project roles and areas of
responsibility, along with brief descriptions and contact
information.
The FreeBSD Core Team constitutes the project's "Board of Directors",
responsible for deciding the project's overall goals and direction as
well as managing specific areas of the FreeBSD project landscape. The
Core Team is elected by the active developers in the project.
&a.allanjude.email; (Clusteradm Liaison)
&a.bapt.email; (Portmgr and CI-team Liaison)
&a.bcr.email;
&a.benno.email; (Code-of-Conduct Committee and Security Team Liaison)
&a.emaste.email;
&a.gnn.email;
&a.hrs.email; (Doceng and Release Engineering Team Liaison)
The FreeBSD Documentation Engineering Team is responsible for
defining and following up documentation goals for the committers
in the Documentation project. The doceng team charter
describes the duties and responsibilities of the Documentation
Engineering Team in greater detail.
The primary responsibility of the FreeBSD Port Management Team is to
ensure that the FreeBSD Ports Developer community provides a ports
collection that is functional, stable, up-to-date and full-featured.
Its secondary responsibility is to coordinate among the committers
and developers who work on it. The portmgr team charter
describes the duties and responsibilities of the Port Management
Team in greater detail.
&a.mat.email; (Cluster Administration Team Liaison)
&a.antoine.email;
&a.bapt.email; (Core Team Liaison)
&a.bdrewery.email; (Release Engineering Team Liaison)
The Primary Release Engineering Team is responsible for setting and
publishing release schedules for official project releases of FreeBSD,
announcing code freezes and maintaining releng/* branches, among other
things. The release engineering team charter
describes the duties and responsibilities of the Primary Release
Engineering Team in greater detail.
The FreeBSD Donations Team is responsible for responding to donations
offers, establishing donation guidelines and procedures, and coordinating
donation offers with the FreeBSD developer community. A more detailed
description of the duties of the Donations Team is available on the FreeBSD Donations Liaison page.
The FreeBSD Security Team (headed by the Security Officer) is
responsible for keeping the community aware of bugs, exploits and
security risks affecting the FreeBSD src and ports trees, and to
promote and distribute information needed to safely run FreeBSD
systems. Furthermore, it is responsible for resolving software
bugs affecting the security of FreeBSD and issuing security
advisories. The FreeBSD
Security Officer Charter describes the duties and
responsibilities of the Security Officer in greater detail.
&a.gordon.email; (Officer)
&a.delphij.email; (Officer Emeritus)
&a.des.email; (Officer Emeritus)
&a.gjb.email; (Cluster Administrators Team Liaison)
Vendor Relations is responsible for handling email
from hardware and software vendors. Email sent to Vendor
Relations is forwarded to the &os; Core Team in addition
to the &os; Foundation.
The &os; Core Team Secretary is a non-voting member of the Core Team,
responsible for documenting the work done by core, keeping track of the
core agenda, direct contact with non-core members sending mail to core
and to be an the interface to the admin team for
committer/account approval. The Core Team Secretary is also responsible
for writing and sending out monthly status reports to the &os;
Developer community, containing a summary of core's latest decisions and
actions.
The FreeBSD Port Management Team Secretary is a non-voting member of the
Port Management Team, responsible for documenting the work done by portmgr,
keeping track of voting procedures, and to be an interface to the other
teams, especially the admin and Core teams. The Port Management Team
Secretary is also responsible for writing and sending out monthly status
reports to the FreeBSD Developer community, containing a summary of
portmgr's latest decisions and actions.
The FreeBSD Security Team Secretary will make sure someone responds to
incoming emails towards the Security Team. He will acknowledge
receipt and keep track of the progress within the Security Team.
If needed the Secretary will contact members of the Security Team to
let them provide an update on ongoing items. Currently the Security
Team Secretary does not handle Security Officer Team items.
The Accounts Team is responsible for setting up accounts for new
committers in the project. Requests for new accounts will not be
acted upon without the proper approval from the appropriate entity.
The Bugmeisters are responsible for ensuring
that the maintenance database is in working order, that the entries are
correctly categorised and that there are no invalid entries. They are
also responsible for the problem report group.
The Cluster Administrators consists of the people responsible for
administrating the machines that the project relies on for its
distributed work and communication to be synchronised. It
consists mainly of those people who have physical access to the servers.
Issues concerning the projects infrastructure or setting up new
machines should be directed to the cluster administrators. This
team is led by the lead cluster administrator whose duties and
responsbilities are described in the cluster administration charter
in greater detail.
The Forum Administrators maintain the &os; Project's web forum site,
located at https://forums.freebsd.org/
and lead the group of moderators who work to ensure the relevance and quality of
forum content.
The FTP/WWW Mirror Site Coordinators coordinate all the FTP/WWW
mirror site adminstrators to ensure that they are distributing current
versions of the software, that they have the capacity to update
themselves when major updates are in progress, and making it easy for
the general public to find their closest FTP/WWW mirror.
E-mail to the Mirror Site Coordinators is currently forwarded to
the Cluster Administration team with the
addition of:
The Perforce Repository Administrators are responsible for
- administrating the FreeBSD perforce source repository and setting up new
- perforce accounts. All requests concerning new perforce accounts
- for non-committers should be directed to the perforce
- administrators.
The Phabricator Administrators are responsible for maintaining the &os;'s
instance of the Phabricator on-line code review tool located at
https://reviews.freebsd.org/
&a.eadler.email;
&a.emaste.email;
&a.lwhsu.email;
&a.mat.email;
&a.robak.email;
&a.rpaulo.email;
For any problems regarding Phabricator, please open a bug report
and select "Services" and then "Code Review".
The Postmaster Team is responsible for mail being correctly delivered
to the committers' email address, ensuring that the mailing lists work,
and should take measures against possible disruptions of project mail
services, such as having troll-, spam- and virus-filters.
The FreeBSD Webmaster Team is appointed by &os; Documentation Engineering Team,
and responsible for keeping the main FreeBSD web
sites up and running. This means web server configuration, CGI scripts,
fulltext and mailing list search. Anything web related, technical stuff
belongs to the scope of the Webmaster Team, excluding bugs in the
documentation.
Email to the Webmaster Team is currently forwarded to the Documentation Engineering team with the
addition of:
&a.wosch.email;
Index: head/en_US.ISO8859-1/htdocs/cgi/cgi-style.pl
===================================================================
--- head/en_US.ISO8859-1/htdocs/cgi/cgi-style.pl (revision 51678)
+++ head/en_US.ISO8859-1/htdocs/cgi/cgi-style.pl (revision 51679)
@@ -1,269 +1,268 @@
# $FreeBSD$
#
# Perl routines to encapsulate various elements of HTML page style.
# For future reference, when is now?
($se,$mn,$hr,$md,$mo,$yr,$wd,$yd,$dst) = localtime(time);
$yr += 1900;
$mo += 1;
$timestamp = "$mo-$md-$yr";
if (!defined($hsty_base)) {
# $hsty_base should be relative if possible, so that mirrors
# serve their local copy instead of going to the main site.
# However, if we aren't running as a cgi, or if we're
# running on cgi, hub, docs or people, use the absolute home path.
if (!defined($ENV{'HTTP_HOST'}) ||
$ENV{'HTTP_HOST'} =~ /(cgi|hub|docs|people|mailarchive.ysv).freebsd.org/i) {
$hsty_base = '//www.FreeBSD.org'
} else {
$hsty_base = '..';
}
}
if (!defined($hsty_email)) {
$hsty_email = 'Contact';
}
if (!defined($hsty_author)) {
$hsty_author = "$hsty_email";
}
if (!defined($hsty_date)) {
$hsty_date = '';
}
if (!defined($hsty_charset)) {
$hsty_charset = 'iso-8859-1';
}
# This can be set to either a string containing an inline CSS stylesheet
# or to a element that references an external CSS stylesheet, to
# make local modifications to the style of a CGI script's output.
$t_style = ""; # Don't allow script to override completely, just
# let the script's setting cascade with the master.
$i_topbar = qq`
`;
#XXX does anyone use this? I don't know what it should be in the new style.
if (!defined($hsty_home)) {
$hsty_home = "";
}
sub html_header {
local ($title, $xhtml) = @_;
return short_html_header($title, $xhtml) . "
`;
}
sub get_the_source {
return if $ENV{'PATH_INFO'} ne '/get_the_source';
open(R, $0) || do {
print "Oops! open $0: $!\n"; # should not reached
exit;
};
print "Content-type: text/plain\n\n";
while() { print }
close R;
exit;
}
1;
Index: head/en_US.ISO8859-1/htdocs/docs/books.xml
===================================================================
--- head/en_US.ISO8859-1/htdocs/docs/books.xml (revision 51678)
+++ head/en_US.ISO8859-1/htdocs/docs/books.xml (revision 51679)
@@ -1,324 +1,318 @@
]>
&title;$FreeBSD$
On this site
All the documentation on this site can be downloaded in a
variety of different formats (HTML, Postscript, PDF, and more)
and compression schemes (BZip2, Zip) from the FreeBSD Download
site.
Archived copies of the &os; documentation (articles, books, and
textinfo manuals) are also available online at http://docs.FreeBSD.org/doc/.
This documentation is provided and maintained by the
FreeBSD
Documentation Project, and we are always looking for
people to contribute new documentation and maintain existing
documentation.
The FreeBSD FAQ
(faq)
Frequently Asked Questions, and answers, covering all aspects of
FreeBSD.
The FreeBSD
Handbook (handbook)
A constantly evolving, comprehensive resource for FreeBSD
users.
The
FreeBSD Developers' Handbook (developers-handbook)
For people who want to develop software for FreeBSD (and not
just people who are developing FreeBSD itself).
The FreeBSD
Architecture Handbook (arch-handbook)
For FreeBSD system developers. This book covers the
architectural details of many important FreeBSD kernel
subsystems.
The Porter's
Handbook (porters-handbook)
Essential reading if you plan on providing a port of a third
party piece of software.
The PMake Tutorial
(pmake)
A tutorial for the make utility. This book is
essential reading for anyone who wants to understand all the
details of using make of reading and writing
makefiles.
Build
Your Own FreeBSD Update Server
(freebsd-update-server)
Using a FreeBSD Update server allows a system administrator to
perform fast updates for a number of machines from a local
mirror.
Writing a GEOM
Class (geom-class)
A guide to GEOM internals, and writing your own class.
Introduction to
NanoBSD (nanobsd)
Information about the NanoBSD tools, which can be used to create
FreeBSD system images for embedded applications, suitable for
use on a Compact Flash card (or other mass storage medium).
FreeBSD First
Steps (new-users)
For people coming to FreeBSD and &unix; for the first time.
-
Perforce in
- FreeBSD Development (p4-primer)
- A guide to the Perforce version control system. It also
- describes how to manage experimental projects with the FreeBSD
- Perforce server.
FreeBSD Release
Engineering (releng)
Describes the approach used by the FreeBSD release engineering
team to make production quality releases of the FreeBSD
Operating System. It describes the tools available for those
interested in producing customized FreeBSD releases for
corporate rollouts or commercial productization.
Kirk McKusick,
one of the original architects of BSD at U.C. Berkeley,
teaches two
4.4BSD Kernel
Internals courses using FreeBSD. For those unable to
attend the courses in person, a video tape series is also
now available.
Appendix A from the college textbook
Operating Systems Concepts by Silberschatz, Galvin
and Gagne has been made available online in PDF
format. The appendix is dedicated to FreeBSD and
offers a good introduction to FreeBSD's internals.
This document is an overall guide for all new committers,
including both technical details and policy details. For the
former, see the chapters on
the Subversion VCS, the
Bugzilla bug tracking system, and the
SSH Quick-Start Guide.
It contains almost everything a new committer to the &os;
Project needs to know. See the Documentation Project Primer and
the Ports Guide, below, for more info.
This primer covers everything you will need to know in order to
start contributing to the &os; Documentation Project, from
the tools and software you will be using (both mandatory and
recommended) to the philosophy behind the Documentation
Project.
&header2.topnav.label;
&header2.topnav;
'>
This document describes how to build and update
the FreeBSD Web pages from the Subversion repository by hand.'>