Re: FreeBSD Documentation

2017-10-29 Thread Ngie Cooper

> On Oct 29, 2017, at 13:53, Rodney W. Grimes 
>  wrote:
> 
> -- Start of PGP signed section.
> [ Charset UTF-8 unsupported, converting... ]
>>> 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
> 
> Lets make this MUCH easier on a user.
> cp /usr/share/man/man8/jail.8.gz /tmp
> cd /tmp
> gzip -d jail.8.gz
> cp -p jail.8 jail.8.orig
> vi jail.8
> diff -u jail.8.orig jail.8 >jail.8.patch
> 
> And then attach that patch to a bugzilla
> 
> More commands, but much shorter amount of time.
> 
> (Of cource broken if your system is not -current or close to it)

No. Just do a sparse checkout of share/man/man8 ... less error prone and one 
has a usable diff instead of a diff that might contain local modifications, or 
be a few revisions behind.

> -- 
> Rod Grimes rgri...@freebsd.org
> ___
> freebsd-current@freebsd.org mailing list
> https://lists.freebsd.org/mailman/listinfo/freebsd-current
> To unsubscribe, send any mail to "freebsd-current-unsubscr...@freebsd.org"
___
freebsd-current@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-current
To unsubscribe, send any mail to "freebsd-current-unsubscr...@freebsd.org"


Re: FreeBSD Documentation

2017-10-29 Thread Rodney W. Grimes
-- Start of PGP signed section.
[ Charset UTF-8 unsupported, converting... ]
> 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

Lets make this MUCH easier on a user.
cp /usr/share/man/man8/jail.8.gz /tmp
cd /tmp
gzip -d jail.8.gz
cp -p jail.8 jail.8.orig
vi jail.8
diff -u jail.8.orig jail.8 >jail.8.patch

And then attach that patch to a bugzilla

More commands, but much shorter amount of time.

(Of cource broken if your system is not -current or close to it)
-- 
Rod Grimes rgri...@freebsd.org
___
freebsd-current@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-current
To unsubscribe, send any mail to "freebsd-current-unsubscr...@freebsd.org"


Re: FreeBSD Documentation

2017-10-29 Thread Benjamin Kaduk
On Sun, Oct 29, 2017 at 07:47:33PM +0300, Yuri Pankov wrote:
> On Sun, 29 Oct 2017 22:13:16 +0800, Blubee Blubeeme wrote:
> > How can we suggest edits for the docs?
> > 
> > The docs still reference using sysinstall to setup a jail when it hasn't
> > been that since at least 2011
> > https://www.freebsd.org/cgi/man.cgi?query=jail&sektion=8&manpath=freebsd-release-ports
> > 
> >   Start a shell in the jail:
> > 
> >jail -c path=/data/jail/testjail mount.devfs \
> >host.hostname=testhostname ip4.addr=192.0.2.100 \
> >command=/bin/sh
> > 
> >   Assuming no errors, you will end up with ashell prompt within the 
> > jail.
> >   You can now run */usr/sbin/sysinstall* and do the post-install 
> > configura-
> >   tion to set various configuration options,or perform these 
> > actions manu-
> >   ally by editing */etc/rc.conf*, etc.
> 
> While you were already given a lot of correct replies, exactly the 
> change you want is already in HEAD (though as noted in followup, it 
> could really say bsdconfig instead of bsdinstall):
> 
> Author: bjk (doc committer)
> Date: Wed Oct 18 22:56:46 2017
> New Revision: 324732
> URL: https://svnweb.freebsd.org/changeset/base/324732
> 
> Log:
>Adopt jail.8 to our brave new bsdinstall world

Indeed.  I have the MFC reminder sitting in my inbox, since the original
commit received such feedback about bsdconfig being a better replacement,
but I haven't had a chance to go review the best change to make in master
(and then MFC).

I would not object if someone beat me to coming up with better text! :)

-Ben
___
freebsd-current@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-current
To unsubscribe, send any mail to "freebsd-current-unsubscr...@freebsd.org"


Re: FreeBSD Documentation

2017-10-29 Thread Yuri Pankov

On Sun, 29 Oct 2017 22:13:16 +0800, Blubee Blubeeme wrote:

How can we suggest edits for the docs?

The docs still reference using sysinstall to setup a jail when it hasn't
been that since at least 2011
https://www.freebsd.org/cgi/man.cgi?query=jail&sektion=8&manpath=freebsd-release-ports

  Start a shell in the jail:

   jail -c path=/data/jail/testjail mount.devfs \
   host.hostname=testhostname ip4.addr=192.0.2.100 \
   command=/bin/sh

  Assuming no errors, you will end up with ashell prompt within the 
jail.
  You can now run */usr/sbin/sysinstall* and do the post-install configura-
  tion to set various configuration options,or perform these 
actions manu-
  ally by editing */etc/rc.conf*, etc.


While you were already given a lot of correct replies, exactly the 
change you want is already in HEAD (though as noted in followup, it 
could really say bsdconfig instead of bsdinstall):


Author: bjk (doc committer)
Date: Wed Oct 18 22:56:46 2017
New Revision: 324732
URL: https://svnweb.freebsd.org/changeset/base/324732

Log:
  Adopt jail.8 to our brave new bsdinstall world

  Submitted by: Steve Kargl
  MFC after:3 days


___
freebsd-current@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-current
To unsubscribe, send any mail to "freebsd-current-unsubscr...@freebsd.org"


Re: FreeBSD Documentation

2017-10-29 Thread Cy Schubert
In message <1509293832.21609.7.ca...@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 
FreeBSD UNIX: Web:  http://www.FreeBSD.org

The need of the many outweighs the greed of the few.


___
freebsd-current@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-current
To unsubscribe, send any mail to "freebsd-current-unsubscr...@freebsd.org"


Re: FreeBSD Documentation

2017-10-29 Thread Cy Schubert
In message , Allan Jude 
write
s:
> This is an OpenPGP/MIME signed message (RFC 4880 and 3156)
> --aGGixulc9uAFLFA2k9VWxk7NcN6fQBdFP
> Content-Type: multipart/mixed; boundary="T6pjExsFmnQlcvXFRkfkRKJem0LXImVKi";
>  protected-headers="v1"
> From: Allan Jude 
> To: freebsd-current@freebsd.org
> Message-ID: 
> Subject: Re: FreeBSD Documentation
> References:  om>
>  <20171029150039.gl34...@home.opsec.eu>
> In-Reply-To: <20171029150039.gl34...@home.opsec.eu>
> 
> --T6pjExsFmnQlcvXFRkfkRKJem0LXImVKi
> Content-Type: text/plain; charset=utf-8
> Content-Language: en-US
> Content-Transfer-Encoding: quoted-printable
> 
> On 2017-10-29 11:00, Kurt Jaeger wrote:
> > Hi!
> >=20
> >> How can we suggest edits for the docs?
> >=20
> > Checkout the docs repo:
> >=20
> >   svn checkout https://svnweb.freebsd.org/doc/head/ .
> >=20
> > Change the relevant files, create a new problem report on
> >=20
> >   https://bugs.freebsd.org/
> >=20
> > and attach the svn diff to that problem report.
> >=20
> 
> 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

Yes, and that's the first step to becoming a committer. I recall sending 
multiple patches because I didn't want to patch brand new FreeBSD systems 
after installing the ISO (they were plastic discs then). (We used FreeBSD 
for infrastructure servers at $JOB at the time.) Then one day there was an 
email from nectar@ in my inbox offering the keys to the farm.


-- 
Cheers,
Cy Schubert 
FreeBSD UNIX: Web:  http://www.FreeBSD.org

The need of the many outweighs the greed of the few.


___
freebsd-current@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-current
To unsubscribe, send any mail to "freebsd-current-unsubscr...@freebsd.org"


Re: FreeBSD Documentation

2017-10-29 Thread Ian Lepore
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.

-- Ian
___
freebsd-current@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-current
To unsubscribe, send any mail to "freebsd-current-unsubscr...@freebsd.org"


Re: FreeBSD Documentation

2017-10-29 Thread Allan Jude
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


-- 
Allan Jude



signature.asc
Description: OpenPGP digital signature


Re: FreeBSD Documentation

2017-10-29 Thread Kurt Jaeger
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.

-- 
p...@opsec.eu+49 171 3101372 3 years to go !
___
freebsd-current@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-current
To unsubscribe, send any mail to "freebsd-current-unsubscr...@freebsd.org"