Re: FreeBSD Documentation

From: Cy Schubert <Cy.Schubert_at_komquats.com>
Date: Sun, 29 Oct 2017 09:38:25 -0700
In message <1509293832.21609.7.camel_at_freebsd.org>, Ian Lepore writes:
> On Sun, 2017-10-29 at 11:37 -0400, Allan Jude wrote:
> > On 2017-10-29 11:00, Kurt Jaeger wrote:
> > > 
> > > Hi!
> > > 
> > > > 
> > > > How can we suggest edits for the docs?
> > > Checkout the docs repo:
> > > 
> > >   svn checkout https://svnweb.freebsd.org/doc/head/ .
> > > 
> > > Change the relevant files, create a new problem report on
> > > 
> > >   https://bugs.freebsd.org/
> > > 
> > > and attach the svn diff to that problem report.
> > > 
> > Since the document in question is a man page, it actually lives in
> > the
> > src tree.
> > 
> > svn checkout https://svn.freebsd.org/base/head/ .
> > 
> > cd usr.sbin/jail
> > 
> > vi jail.8
> > 
> > svn diff > jail_manpage.patch
> > 
> > And then attach that patch to a bugzilla, or upload it to
> > reviews.freebsd.org
> > 
> > 
> 
> I hope I'm right in thinking that just submitting the proposed changes
> as plain text would also be an option?  I suspect there are more people
> with good ideas on improving manpages than there are people who've
> decided they really want to learn the arcane skill of manpage markup
> language.

That's a useful skill too. Not just here but in Solaris, AIX and Linux. IMO 
every sysadmin should have a rudimentary nroff markup skill.

But if the markup is indeed an impediment, just sending in text will work 
too.


-- 
Cheers,
Cy Schubert <Cy.Schubert_at_cschubert.com>
FreeBSD UNIX:  <cy_at_FreeBSD.org>   Web:  http://www.FreeBSD.org

	The need of the many outweighs the greed of the few.
Received on Sun Oct 29 2017 - 15:38:29 UTC

This archive was generated by hypermail 2.4.0 : Wed May 19 2021 - 11:41:13 UTC