os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
45834 commits 1 branch 79 tags 298 MiB
Commit graph

466 commits

Author SHA1 Message Date
Eitan Adler
80ac50a87b Fix, odd comma 2013-12-08 20:03:50 +00:00
Eitan Adler
e806e04158 Document the "Dogs of FreeBSD" page. 2013-12-08 20:01:07 +00:00
Eitan Adler
72f4e4107a Misc fixes to the merging section of the committer's guide: 
- add xml:id to section header
	- remove period of title
	- correctly capitalize title
	- adding missing ','

Reported by:	lint^W wblock
 2013-12-08 02:23:48 +00:00
Eitan Adler
0ab43263c7 Update the merging chapter and explain the new merging policy. 
Reviewed by:	peter
 2013-12-07 23:00:33 +00:00
Hiroki Sato
8def749c53 Normalize DTD URL. 2013-11-13 07:52:45 +00:00
Eitan Adler
fd79a9afc6 Modernize the Coverity chapter. 2013-11-13 06:05:48 +00:00
Eitan Adler
1556f96ba4 Fix nits. 
Drop suggestion that the MFC time may be left off.

Reported by:	gavin
 2013-11-13 02:25:30 +00:00
Eitan Adler
e470db943c Fix spelling errors I introduced. 
Reported by:	koobs
 2013-11-11 12:18:24 +00:00
Eitan Adler
13ebce2b52 s/singular/plural 2013-11-11 04:12:16 +00:00
Eitan Adler
7f11127e5f Remove or fix some vestiges of the CVS era. 2013-11-11 04:11:00 +00:00
Eitan Adler
7a38886206 We switched to XML from SGML. 2013-11-11 04:08:18 +00:00
Eitan Adler
ee4b3bc705 Split out and expand upon the committer guide's discussion of commit logs. 
Some discussion about how to write an appropriate commit log description should be included.  The section currently only discusses the 'meta data'.
 2013-11-11 04:07:57 +00:00
Gabor Kovesdan
24d129e8d1 - Definitively upgrade to DocBook 5.0 2013-11-07 15:39:28 +00:00
Xin LI
f88ba923bb Mention stable/10 branch in various places. 2013-10-10 23:56:55 +00:00
Glen Barber
9782ab9419 Fix a minor nit: 'svn commit' should probably not be done as root when 
committing to the Project repositories.
 2013-09-27 20:13:51 +00:00
Eitan Adler
9b698710af Add some instructions for committers that need to ask questions. 
Adapted from mail sent by bz@ to an internal list.
 2013-09-22 17:24:51 +00:00
Warren Block
8df38f00ca Clarity and punctuation improvements. 2013-08-03 14:10:45 +00:00
Warren Block
eca552f570 Removing a port also requires removing the directory. 
PR:		docs/180579
Submitted by:	Matthias Andree <mandree@FreeBSD.org>
 2013-07-15 18:35:24 +00:00
Rene Ladan
1d9bea10ed Merge the projects/entities branch into head/ 
The primary purposes are to clean up duplicated author definitions in
both share/xml/authors.ent and share/xml/developers.ent, and as a added
bonus simplify writing up author names/email addresses in web pages.

Apart from merging developers.ent into authors.ent, removing the former,
and updating the Committers Guide there should be little user-visible changes:
- a.portmgr renamed to a.portmgr.members
- a.doceng renamed to a.doceng.members
- team.re renamed to a.re.members.email and moved from
share/xml/freebsd.ent to share/xml/authors.ent
- a.core updated and moved from share/xml/mailing-lists.ent to
share/xml/teams.ent
- share/pgpkeys/{addkey.sh|README} updated

Translations are untouched except for build fixes.

Approved by:	doceng (gjb)
Approved by:	gjb (mentor)
 2013-07-09 21:15:47 +00:00
Warren Block
6091078973 Fix a spelling error. 
Submitted by:	Benjamin Kaduk <kaduk@MIT.EDU>
 2013-07-01 00:55:20 +00:00
Warren Block
25f2fded6c Whitespace-only fixes. Translators, please ignore. 2013-06-30 23:26:58 +00:00
Warren Block
8ce29fd673 Change 'svn switch --relocate' to 'svn relocate'. 
Use &os; in reference to $FreeBSD$ version string.
Rewrite some sections that had defined svn operations in terms of
what CVS did so they can stand alone.
Remove confusing reference to 'svn rmdir', which does not, in fact,
actually exist.
 2013-06-30 23:11:05 +00:00
Eitan Adler
4255d4b1d6 "svn move" is not identical to "svn copy, svn remove" since 1.8. 
In particular, the move is recorded within the working copy (although not on the server).
 2013-06-30 22:54:32 +00:00
Warren Block
eea02c6dfa Add and unify IDs in SVN Primer. Add note about $FreeBSD$ string for 
adding new files.  Rewrite confusing svn rm explanation.  Add
explanation to svn cp.

Reviewed by:	remko, jilles (both only for $FreeBSD$ note)
 2013-06-30 21:24:06 +00:00
Warren Block
8dab5bc900 Minor whitespace-only fix. Translators, please ignore. 2013-06-30 01:55:10 +00:00
Warren Block
3a5648505e Content updates: replace FreeBSD with &os; where appropriate, rewrite a 
stilted paragraph on SSH.
 2013-06-30 01:52:06 +00:00
Warren Block
664044ec54 Additional whitespace-only fixes. Translators, please ignore. 2013-06-30 01:37:37 +00:00
Warren Block
626a51d85e Whitespace-only changes. Translators, please ignore. 2013-06-30 01:00:50 +00:00
Warren Block
aac92ebdaf Fix wording errors, title capitalization, remove some outdated 
CVS-specific notes.
 2013-06-29 22:59:48 +00:00
Eitan Adler
fd6ba6e9e0 Add link to the svn book. 2013-06-12 21:04:17 +00:00
Eitan Adler
31349ce7ce Remove leftover references to svk. 2013-06-12 21:01:43 +00:00
Gabor Kovesdan
7292289d38 - MFH 2013-05-07 10:20:20 +00:00
Gabor Kovesdan
5f2c2b6ba3 - MFH 2013-04-30 09:50:22 +00:00
Glen Barber
8adbec96bf Remove stable/7 from list of noteworthy branches. 2013-04-16 23:10:07 +00:00
Glen Barber
baa938e087 Update to reflect DES is now security officer. 2013-04-16 23:09:14 +00:00
Gabor Kovesdan
b1f6349527 - MFH 2013-03-20 21:05:33 +00:00
Bryan Drewery
7a74b7fe4f Fix broken link to portmgr implementation page 
Approved by:	gjb (via IRC)
 2013-03-13 17:52:57 +00:00
Craig Rodrigues
e656a3a416 Add '/head' to the list of branches mentioned in the section, "RELENG_* Branches and General Layout" 
Reviewed by: keramida
 2013-03-12 22:59:53 +00:00
Gavin Atkinson
e393167cf3 Swap example URLs containing svn://svn.freebsd.org for 
https://svn0.us-west.freebsd.org, and add a reference to the list of
mirror sites.

Discussed with:	simon (months ago)
Approved by:	bcr (mentor)
 2013-03-07 13:21:13 +00:00
Gavin Atkinson
001dbdf45d Update the Subversion Primer in the committers-guide: 
- Explains the current state of the svn exporter, specifically that
  it should be viewed as legacy, and will not remain forever.
- Drop the one and only reference to csup.
- Drop the inclusion of the CVSup trademark attribution, no longer
  required since r40063.

Approved by:	bcr (mentor)
 2013-03-06 18:12:47 +00:00
Eitan Adler
0557f5eb66 Modernize the GNATS mirroring section 
PR:		docs/176435
Submitted by:	jgh
Approved by:	bcr (mentor)
 2013-03-04 19:16:04 +00:00
Gabor Kovesdan
3ab2d87bc1 - MFH 2013-02-18 15:29:06 +00:00
Eitan Adler
8679afc9f4 Access to cvsup-master is not very important anymore. 
Reviewed by:	doc (remko, gavin, crees)
Approved by:	bcr (mentor)
 2013-02-05 14:15:57 +00:00
Gabor Kovesdan
a06603e1e8 - MFH 2013-02-05 09:14:34 +00:00
Gabor Kovesdan
5df509eaa2 - Remove standalone="no" statements from XML declarations since it did not 
always work and is no use anyway
 2013-01-30 19:12:36 +00:00
Gabor Kovesdan
36cdb51546 - Migrate the documentation set to DocBook 4.5 2013-01-30 14:00:53 +00:00
Eitan Adler
0ef24a8970 Make it clear that reverts should contain mergeinfo. 
Discussed with:	brooks
Approved by:	bcr (mentor)
 2013-01-25 14:27:47 +00:00
Glen Barber
737666e0b0 Remove 'www/' tree references. 
Bump copyright date where needed.
 2013-01-22 01:44:48 +00:00
Gabor Kovesdan
d95165dc16 - Make the English documentation valid XML 2013-01-21 17:37:33 +00:00
Glen Barber
f81066ea79 Fix a misplaced ";". 2013-01-14 01:18:01 +00:00
Glen Barber
c6db15d674 Fix broken entities. 2013-01-14 00:57:45 +00:00
Eitan Adler
317efb77f2 The "svn switch" tip isn't needed anymore, but the ControlMaster 
tip can help with TCP latency.

While here: modernize the makefile options and clarify the text

Approved by:	bcr (mentor)
 2012-12-07 13:00:46 +00:00
Eitan Adler
d3a8d92712 Correct the section talking about when to use the commit message mailing 
list in the "Committer's guide"

Approved by:	bcr (mentor)
 2012-12-02 16:58:11 +00:00
Glen Barber
29a845ec3c Fix path to authors.ent. 
Submitted by:	flo
 2012-11-25 16:59:59 +00:00
Eitan Adler
3c47d51f1b CVSup is dying. CVS is dying. Sysinstall is dead. 
Approved by:	bcr (mentor)
 2012-11-18 14:16:40 +00:00
Eitan Adler
1dc6f00327 SVK is no longer actively developed. 
Approved by:	jkois (mentor)
 2012-11-09 12:14:00 +00:00
Eitan Adler
6653a22237 - This entire article is for committers (and gnats-only folk). 
- We no longer use CVS.

Approved by:	bcr (mentor)
 2012-10-26 15:20:35 +00:00
Niclas Zeising
7fa58ce1f4 Update maintainer info regarding the addport and rmport scripts. Crees is 
the current maintainer and would like to be CCd on any issues regarding
these scripts.

PR:		docs/170822
Submitted by:	crees
Reviewed by:	eadler (earlier version)
Approved by:	joel (mentor)
 2012-10-09 16:18:13 +00:00
Eitan Adler
43e45dcd2e Remove reference to non-existent repocopy operation. 
Approved by:	gabor
 2012-10-07 21:38:07 +00:00
Eitan Adler
52ebc2de70 Reduce the presence of CVS in the committers guide. Comparisons with CVS 
are not needed anymore.

Approved by:	bcr
 2012-10-02 19:46:32 +00:00
Gabor Kovesdan
77d737ee88 - Rename the share/sgml directories to share/xml 
- Fix build errors from the next change

Approved by:	doceng (implicit)
 2012-10-01 11:56:00 +00:00
Gabor Kovesdan
b4346b9b2d - Rename .sgml files to .xml 
- Reflect the rename in referencing files

Approved by:	doceng (implicit)
 2012-10-01 09:53:01 +00:00
Thomas Abthorpe
124917ccbd - Fix a typo 
Approved by:	gjb
 2012-09-21 03:54:41 +00:00
Thomas Abthorpe
5b796df221 - Fix a typo 
- Standardize on en_US spellings for synchronize and summarize

Approved by:	gjb
 2012-09-17 20:28:41 +00:00
Baptiste Daroussin
966e5b4854 Fix documentation on how to tag a new import in vendor branch 
Approved by:	gjb
 2012-09-14 21:30:38 +00:00
Gabor Kovesdan
9c243757ef - XML declarations should use IANA encoding names 
Pointed out by:	hrs
 2012-09-14 17:47:48 +00:00
Gabor Kovesdan
0421ffc179 - MFH 
Approved by:	doceng (implicit)
 2012-09-04 21:35:17 +00:00
Gabor Kovesdan
763dee20eb - MFH 
Approved by:	doceng (implicit)
 2012-08-27 11:43:27 +00:00
Niclas Zeising
a99fa7ec07 Improve wording. 
Suggested by:	wblock
Approved by:	joel (mentor)
 2012-08-22 18:11:32 +00:00
Niclas Zeising
0f988a5254 Add a more concrete example on how to do a MFC. 
Approved by:	joel (mentor)
 2012-08-22 14:55:20 +00:00
Gabor Kovesdan
2e51ec7022 - Strip unnecessary trailing spaces 
Approved by:	doceng (implicit)
 2012-08-21 19:16:02 +00:00
Gabor Kovesdan
7ba98a21ad MFH 
Approved by:	doceng (implicit)
 2012-08-19 23:05:52 +00:00
Beat Gaetzi
1efc6e026b - Remove CVS chapter as ports has switched to Subversion too 
- Add ports specific information to the Subversion primer

PR:		docs/169772
Submitted by:	myself, modified by gjb
Approved by:	gjb
 2012-07-15 19:31:37 +00:00
Gabor Kovesdan
e6b69c3357 - XMLify English articles 
Approved by:	doceng (implicit)
 2012-06-21 16:01:00 +00:00
Gabor Kovesdan
c63960af49 - Simon is the current Security Officer 2012-06-04 17:42:19 +00:00
Glen Barber
0d49f6f951 Minor wording fixes to the committer's guide note about the subversion 
auto-props.

Patch by:	bjk
 2012-05-30 13:18:54 +00:00
Glen Barber
a27db5edde Add trailing comma to 'i.e.' and 'e.g.'. 
Fix a typo.

Translators can likely ignore this change.
 2012-05-30 00:33:27 +00:00
Glen Barber
269baba8a3 Whitespace cleanup: 
- Wrap long lines
- Remove trailing/leading whitespace
- Clean up superfluous empty lines

Translators, please ignore.
 2012-05-30 00:05:46 +00:00
Isabell Long
58d884309b Typo fix: baycc -> byacc. 
Approved by:	gabor (mentor, implicit - requested during review)
 2012-05-29 12:54:49 +00:00
Isabell Long
40e13b78cd Update the vendor imports section of the Subversion Primer to reflect changes 
in the wiki page.

Reviewed by:	gavin
Approved by:	gabor (mentor)
 2012-05-29 12:46:33 +00:00
Glen Barber
e90e72b311 Comment a seemingly unwritten section in the Subversion Primer. 2012-05-28 18:06:06 +00:00
Glen Barber
a8cd62134d - Add a sect id to the Adding/Removing files section of the 
Subversion Primer
- Clarify 'FreeBSD=%H' is the 'svn:keywords' property that is set
- Replace a ulink with an xref to the new section id

Suggested by:	gavin
 2012-05-28 17:51:38 +00:00
Glen Barber
2a656be85a Document that new files that do not have the FreeBSD=%H svn property 
set will be rejected when committing, and link to the Adding/Removing
files section of the Subversion Primer.

Prompted by:	jkois, tj
 2012-05-28 17:25:48 +00:00
Glen Barber
84c284fbef - Update the Conventions and Traditions to reflect the doc CVS->SVN 
conversion.
- Add a note that the .ent, .sgml, and .xml files are in the doc
  repository.
 2012-05-20 20:55:21 +00:00
Glen Barber
6bc7d259d8 Add a brief section to the Subversion Primer outlining the layout 
of the doc SVN repository.
 2012-05-19 23:49:28 +00:00
Glen Barber
3e549043d9 Whitespace-only commit to separate words with a space. :( 
Translators please ignore.
 2012-05-19 22:58:33 +00:00
Glen Barber
6117c1277e Updates to the Committer's Guide to reflect the CVS->SVN Documentation 
repository conversion:

- Replace "Main Subversion Root" with "src/ Subversion Root", and add
  and equivalent entry for the doc/ tree root
- Replace "Main CVSROOTs" with "ports/ CVS Root" and remove the listing
  for the doc/ CVS tree
- Specify the src/ tree in a listing of noteworthy branches
- Update an example to use "pcvs" instead of "dcvs"
 2012-05-19 22:51:07 +00:00
Glen Barber
88b6aa3ae7 Fix the location of a trailing "/" in a <replaceable> tag for 
consistency.
 2012-05-19 22:30:51 +00:00
Glen Barber
3f10b7efb2 Update the committers-guide article to reflect the Documentation 
CVS->SVN conversion:

- Remove references of 'dcvs' from the VCS Operations Guide
- Fix the date the src tree was moved from CVS->SVN while here
- Add the date the doc CVS->SVN conversion was officially complete
- Add doc-specific notes to the Subversion primer
- Document that, though the Subversion Primer is written with the src
  tree in mind, the underlying concepts are the same
 2012-05-19 16:55:27 +00:00
Eitan Adler
4e30910ab2 Add further conventions and traditions to do when first getting your commit bit. 
Approved by:	bcr
 2012-04-23 17:55:07 +00:00
Benedict Reuschling
5f35b677f4 Add a section about vendor imports, which is a part of the Subversion 
Primer from the FreeBSD wiki.

PR:		docs/167033
Submitted by:	Isabell Long (isabell issyl0 co uk)
 2012-04-18 19:23:55 +00:00
Gavin Atkinson
c305236322 Fix a cross-reference that should point to the Subversion guide, bit instead 
pointed to the CVS guide.  Also add a cross-reference to the Subversion
giude within the CVS information itself.

Approved by:	jkois (mentor)
 2012-04-03 12:07:47 +00:00
Eitan Adler
17dc2529c9 - Add information on merging to other share/ subdirectories 
- While here fix a style nit: "man pages" -> "manual pages"

Approved by:	simon
 2012-03-24 18:21:49 +00:00
Eitan Adler
671d3cc419 - Remove broken instructions for installing GNATS on your local machine 
- Add information about useful GNATS tools (change-pr and friends)
- Clean up mirroring instructions a bit

Approved by:	miwi
 2012-03-20 02:53:54 +00:00
Glen Barber
2a3f2c0dc1 Remove a reference to the Vendor Import section that does not yet 
exist.  (My fault for not noticing this section does not exist when
originally committing this.)

Submitted/patched by:	Isabell Long (isabell121%gmail!com)
 2012-03-17 22:53:56 +00:00
Glen Barber
53f56c7b9d - Link to Subversion Primer in Committer's Guide rather than the wiki 
- Use <note> rather than "It is important to note that"
- Grammar fixes

PR:		165920
Submitted by:	crees
 2012-03-11 15:32:12 +00:00
Ryusuke SUZUKI
7267f81a2b PR: docs/165909 
Mention stable/9 tag as noteworthy in Administrative Details

Submitted by:	crees@
 2012-03-11 01:17:35 +00:00
Glen Barber
faee8549f6 Remove retired mailing lists from documentation. 
Submitted by:	sahil
PR:		165436
 2012-02-24 14:10:05 +00:00
Glen Barber
184378d10f Add the Wiki SubversionPrimer entry to the Committers' Guide. 
This work was done as part of Google Code-In (GCIN) 2011.

GCIN student:		Isabell Long (isabell121 gmail com)
GCIN task mentors:	des, rea
Minor rewriting by:	gjb (myself) [1]

[1] The original task was to put this in the Developers' Handbook,
but as discussed with des, the CVS information is in the Committers'
guide; the Subversion Primer entry likely belongs here as well.
 2012-02-17 22:34:05 +00:00
Chris Rees
1d194a0a68 Stop talking about CVSROOT-ports/modules; Edwin has been updating that for years 
PR:		docs/163408
Submitted by:	crees (me)
Approved by:	remko
 2012-01-14 11:48:00 +00:00