Re: manpages query (net/openntpd)

[Benjamin Kaduk]

On Sun, May 10, 2020 at 09:32:03PM +0100, Frank Shute wrote:
> 
> Hi,
> 
> 
> I installed net/openntpd some time ago. I think I read about it's usage
> possibly on OpenBSD's site. Installed it & did the necessary in rc.conf
> 
> The other day I wanted to have a look at the local docs for it as I felt the
> need to twiddle with its start up args. As always, I have a look to see what
> docs it comes with:
> 
> $ pkg info -l openntpd
> 
> openntpd-6.2p3_2,2:
>   /usr/local/etc/ntpd.conf.sample
>   /usr/local/etc/periodic/daily/480.status-openntpd
>   /usr/local/etc/rc.d/openntpd
>   /usr/local/man/man5/ntpd.conf.5.gz
>   /usr/local/man/man8/ntpctl.8.gz
>   /usr/local/man/man8/ntpd.8.gz
>   /usr/local/sbin/ntpctl
>   /usr/local/sbin/ntpd
>   /usr/local/share/licenses/openntpd-6.2p3_2,2/ISCL
>   /usr/local/share/licenses/openntpd-6.2p3_2,2/LICENSE
>   /usr/local/share/licenses/openntpd-6.2p3_2,2/catalog.mk
> 
> Ok.
> 
> $ man ntpd
> 
> Problems. As in front of it in $MANPATH is:
> 
> /usr/share/man/man8/ntpd.8.gz
> 
> and all the other manpages for ntpd from base.
> 
> I happened to realise what was happening, so I could have a look at man(1)
> and:
> 
> $ man -M /usr/local/man: ntpd
> 
> so as to display the port manpage rather than the one installed by base.
> 
> This seems to be a POLA violation and I was wondering how, if at all, it
> should be handled. A pkg message or rename the binaries or something else?

I think a proper solution would be pkgbase, where installing the ntpd from
ports could cause the one from base to be removed.  Until then, I suppose
that MANPATH and PATH should stay in sync, but it may be worth adding a
note to the pkg-message.  I believe it would be okay to create a bugzilla
entry (https://bugs.freebsd.org/bugzilla/enter_bug.cgi) against the port
requesting this enhancement.

Thanks for raising the question,

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

Re: Error building docs *blank page!!* *bad magic number 0x2d67*

[Benjamin Kaduk]

On Wed, Nov 13, 2019 at 07:40:21PM +0100, driesm.michi...@gmail.com wrote:
> > -Original Message-
> > From: Benjamin Kaduk 
> > Sent: woensdag 13 november 2019 8:39
> > To: driesm.michi...@gmail.com
> > Cc: freebsd-doc@freebsd.org
> > Subject: Re: Error building docs *blank page!!* *bad magic number 0x2d67*
> > 
> > What does pkg(1) think the  version of the installed
> /usr/local/bin/pnmtopng is
> > (on both systems)?
> It's the same on both machines, version 10.88.00 installed by the netpbm
> package.

Huh, perhaps the final messages are just a red herring.

Could you save the entire build log to a file and post it on a website
somewhere (not in email)?

Thanks,

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

Re: Error building docs *blank page!!* *bad magic number 0x2d67*

[Benjamin Kaduk]

What does pkg(1) think the  version of the installed
/usr/local/bin/pnmtopng is (on both systems)?

-Ben

On Mon, Nov 11, 2019 at 09:46:31PM +0100, driesm.michi...@gmail.com wrote:
> Hi doc mailing list,
> 
>  
> 
> Since a few weeks now, I have been unable to build the documentation tree. 
> 
> The build always stops with the output snippet below.
> 
>  
> 
> /usr/local/bin/scr2png  <
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /mail/pine5.scr >
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /mail/pine5.png
> 
> tmpfile=$(mktemp
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /advanced-networking/net-routing.ps.);  groff -p -S -Wall -mtty-char
> -man
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /advanced-networking/net-routing.pic > $tmpfile && /bin/mv -f $tmpfile
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /advanced-networking/net-routing.ps
> 
> tmpfile=$(mktemp
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /advanced-networking/net-routing.eps.);  /usr/local/bin/gs -q
> -dNOPAUSE -dBATCH -dSAFER -dDELAYSAFER  -sPAPERSIZE=letter -r72
> -sDEVICE=bbox  -sOutputFile=/dev/null
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /advanced-networking/net-routing.ps > $tmpfile 2>&1;  /usr/bin/env
> outfile=$tmpfile /usr/local/bin/gs -q -dNOPAUSE -dSAFER -dDELAYSAFER
> -sPAPERSIZE=letter -r72 -sDEVICE=bit  -sOutputFile=/dev/null  ps2epsi.ps <
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /advanced-networking/net-routing.ps 1>&2;  (echo "save countdictstack mark
> newpath /showpage {} def /setpagedevice {pop} def"; echo "%%EndProlog"; echo
> "%%Page: 1 1"; echo "%%BeginDocument:
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /advanced-networking/net-routing.ps"; ) >> $tmpfile;  /usr/bin/sed  -e
> '/^%%BeginPreview:/,/^%%EndPreview[^!-~]*$/d'  -e '/^%!PS-Adobe/d'  -e
> '/^%%[A-Za-z][A-Za-z]*[^!-~]*$/d' -e '/^%%[A-Za-z][A-Za-z]*: /d' <
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /advanced-networking/net-routing.ps >> $tmpfile;  (echo "%%EndDocument";
> echo "%%Trailer"; echo "cleartomark countdictstack exch sub { end } repeat
> restore"; echo "%%EOF"; ) >> $tmpfile;  /bin/mv -f $tmpfile
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /advanced-networking/net-routing.eps
> 
> blank page!!
> 
> /usr/local/bin/perl /usr/doc/share/misc/epsgeom -offset 100 100
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /advanced-networking/net-routing.eps  | /usr/local/bin/gs -q -dBATCH
> -dGraphicsAlphaBits=4 -dTextAlphaBits=4  -dEPSCrop -r100x100  -dNOPAUSE
> -dSAFER -sDEVICE=pnm -sOutputFile=-  -g`/usr/local/bin/perl
> /usr/doc/share/misc/epsgeom -geom 100 100
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /advanced-networking/net-routing.eps` -  | /usr/local/bin/pnmtopng >
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /advanced-networking/net-routing.png
> 
> Error: no BoundingBox found:
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /advanced-networking/net-routing.eps
> 
> Error: no BoundingBox found:
> /usr/doc/en_US.ISO8859-1/books/handbook/../../../share/images/books/handbook
> /advanced-networking/net-routing.eps
> 
> pnmtopng: bad magic number 0x2d67 - not a PPM, PGM, PBM, or PAM file
> 
> *** Error code 1
> 
>  
> 
> I have done some preliminary troubleshooting in a VM and the error does not
> occur on FreeBSD-CURRENT, I'm running 12-STABLE myself.
> 
> There is also a PR open for this, would appreciate if someone more skilled
> with the technical side of the DOC tree could take a look and provide
> feedback.
> 
>  
> https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=234126
> 
>  
> 
> Regards,
> 
> Dries
> 
>  
> 
> ___
> freebsd-doc@freebsd.org mailing list
> https://lists.freebsd.org/mailman/listinfo/freebsd-doc
> To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"
___
freebsd-doc@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: Which comma style does the FreeBSD handbook use? Or is that up to individual contributors and editors?

[Benjamin Kaduk]

On Sat, Oct 05, 2019 at 05:02:28PM +, Pau Amma wrote:
> I've seen examples of both styles in the handbook, eg
> https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/audit-administration.html
> and
> https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/network-usb-tethering.html,
> so I'm unsure.
> 
> Important note: I'm only asking which one (if not both) the FreeBSD
> handbook is actually using. All arguments about what it should use
> (instead) or which style is better will be cheerfully ignored.

https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style-guidelines.html
says "use the serial comma".

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

Re: Incorrect link

[Benjamin Kaduk]

On Tue, Jul 23, 2019 at 03:39:52PM +0300, A P wrote:
> Hi. When browsed docs -
> https://www.freebsd.org/doc/ru/articles/explaining-bsd/compairing-bsd-and-linux.html
> -
> I found the incorrect link about Concurrent Versions System. Adding the
> screenshot.
> 
> It goes onto site of low cost tree removal, which in the context of trees
> and versions very ironic :D
> 
> As I can see, the official site is - https://www.nongnu.org/cvs/
> 
> Good luck to you and best wishes.

Thanks for reporting this.  It seems that it is only present in translated
versions of the article, and the english version has had the text entirely
changed in https://svnweb.freebsd.org/doc?view=revision=47684 .
It's not clear to me whether it's better to have a non-speaker of the
translated languages (like me) try to bulk-adjust the link, or have the
translation teams pull in the change from the english document.

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

Re: Incorrect information

[Benjamin Kaduk]

Hi James,

On Wed, Apr 24, 2019 at 07:50:47PM -0400, James Larrowe wrote:
> This page
> 
> contains
> invalid information. The correct version is included below.

Perhaps you could say a bit more about what motivates the changes and why
you believe they are more correct than the current text at the location you
linked to?

Clarifying that Linux is under GPLv2 is relatively straightforward, and
adding links and shuffling text around are editorial changes, of course,
but I'm not sure I can explain the changes in the final paragraph in the
same way you intended.

Thanks,

Ben

> While the commercial Unix wars raged, the Linux kernel was developed as a
> PC Unix clone. Linus Torvalds credits the existence of the GNU C compiler
> and the associated GNU tools for the existence of Linux. He put the Linux
> kernel under the GPLv2.
> 
> Remember that the GPL requires anything that statically links to any code
> under the GPL also be placed under the GPL. The source for this code must
> thus be made available to the user of the program. Pressure to put
> proprietary applications on Linux became overwhelming. Such applications
> often must link with system libraries. This resulted in a modified version
> of the GPL called the LGPL
>  ("Library", since
> renamed to "Lesser", GPL). The LGPL allows proprietary code to be linked to
> the GNU C library, glibc. Dynamic linking is not considered a violation of
> the LGPL. You do not have to release the source to code which has been
> dynamically linked to an LGPLed library.
> 
> If you statically link an application with glibc, such as is often required
> in embedded systems, either the source or linkable object files must be
> released. Both the GPL and LGPL require any modifications to the code
> directly under the license to be released.
> ___
> freebsd-doc@freebsd.org mailing list
> https://lists.freebsd.org/mailman/listinfo/freebsd-doc
> To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"
___
freebsd-doc@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: New account on FreeBSD Wiki

[Benjamin Kaduk]

On Mon, Feb 25, 2019 at 01:15:13PM +, Mark Linimon wrote:
> On Mon, Feb 25, 2019 at 10:20:41PM +1100, Trevor Roydhouse wrote:
> > To be fair, the Wiki was changed AFTER Grégory mailed the list.
> 
> As a result of ;-)

Well, shame on me for not having checked the history.

Grégory, my apologies for telling you that you didn't follow the procedure,
when in fact you did follow the procedure that was listed at the time.

Mark, thanks for updating the page to more accurately reflect reality :)

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

Re: New account on FreeBSD Wiki

[Benjamin Kaduk]

On Sun, Feb 24, 2019 at 06:40:59PM +0100, Grégory Reinbold wrote:
> Hello
> 
> I want to updload my tutorial to setup a CalDAV/CardDAV server with Radicale.
> My tutorial is already linked on the following page
> https://wiki.freebsd.org/Ports/www/radicale?highlight=(\bCategoryHowTo\b) but 
> I
> wish to integrate it directly on the wiki and add a few more.

https://wiki.freebsd.org/AboutWiki says that this is the second-tier place
to ask about new accounts.  Did you try the first suggestions already?

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

Re: FreeBSD web build failed on build-web.ysv.freebsd.org

[Benjamin Kaduk]

I had assumed it was just waiting for INDEX to be regenerated, since tobik
has changed the offending port's COMMENT already.

-Ben

On Tue, Jan 29, 2019 at 06:39:21PM +, Glen Barber wrote:
> I'm poking at the build machine now.  Ignore any excessive failure
> emails.  I think I see what is(n't) going on.
> 
> Glen
> 
> On Tue, Jan 29, 2019 at 06:36:40PM +, User Www-data wrote:
> > for categoryfile in `grep "^[a-z]" 
> > /usr/local/www/build/head/en_US.ISO8859-1/htdocs/ports/categories | sed -e 
> > s"/,.*//"`; do  echo -n " $categoryfile.xml" >> Makefile.gen;  done
> > echo >> Makefile.gen
> > --- all ---
> > cd /usr/local/www/build/head/ja_JP.eucJP/htdocs/ports;  make  -j 8 -J 15,16 
> > .MAKE.LEVEL.ENV=MAKELEVEL DIRPRFX=../../ja_JP.eucJP/htdocs/ports/ -f 
> > /usr/local/www/build/head/ja_JP.eucJP/htdocs/ports/Makefile.inc0 all
> > --- x11-fonts.html ---
> > env 
> > XML_CATALOG_FILES="file:///usr/local/www/build/head/ja_JP.eucJP/htdocs/ports/catalog-cwd.xml
> >   file:///usr/local/www/build/head/ja_JP.eucJP/share/xml/catalog.xml  
> > file:///usr/local/www/build/head/share/xml/catalog.xml  
> > file:///usr/local/share/xml/catalog" /usr/local/bin/xmllint  --xinclude 
> > --valid --noout --nonet x11-fonts.xml
> > encoding error : input conversion failed due to input error, bytes 0xE2 
> > 0x80 0x99 0x73
> > encoding error : input conversion failed due to input error, bytes 0xE2 
> > 0x80 0x99 0x73
> > I/O error : encoder error
> > x11-fonts.xml:215: parser error : Premature end of data in tag dd line 215
> > n-hill">linden-hill-g20110526 Digital version of Frederic 
> > Goudy
> > 
> >^
> > x11-fonts.xml:215: parser error : Premature end of data in tag dl line 26
> > n-hill">linden-hill-g20110526 Digital version of Frederic 
> > Goudy
> > 
> >^
> > x11-fonts.xml:215: parser error : Premature end of data in tag body line 19
> > n-hill">linden-hill-g20110526 Digital version of Frederic 
> > Goudy
> > 
> >^
> > x11-fonts.xml:215: parser error : Premature end of data in tag html line 12
> > n-hill">linden-hill-g20110526 Digital version of Frederic 
> > Goudy
> > 
> >^
> > *** [x11-fonts.html] Error code 1
> > 
> > make[3]: stopped in /usr/local/www/build/head/ja_JP.eucJP/htdocs/ports
> > 1 error
> > 
> > make[3]: stopped in /usr/local/www/build/head/ja_JP.eucJP/htdocs/ports
> > *** [all] Error code 2
> > 
> > make[2]: stopped in /usr/local/www/build/head/ja_JP.eucJP/htdocs/ports
> > 1 error
> > 
> > make[2]: stopped in /usr/local/www/build/head/ja_JP.eucJP/htdocs/ports
> > *** [all] Error code 2
> > 
> > make[1]: stopped in /usr/local/www/build/head/ja_JP.eucJP/htdocs
> > 1 error
> > 
> > make[1]: stopped in /usr/local/www/build/head/ja_JP.eucJP/htdocs
> > *** [all] Error code 2
> > 
> > make: stopped in /usr/local/www/build/head/en_US.ISO8859-1/htdocs
> > 1 error
> > 
> > make: stopped in /usr/local/www/build/head/en_US.ISO8859-1/htdocs
> >32.78 real15.91 user11.07 sys
> > 
> > latestrevision.timestamp "2019-01-28 12:37:45" 
> > latestrevision.committer "dbaio"
> > latestrevision.number "52785"
> > ___
> > freebsd-doc@freebsd.org mailing list
> > https://lists.freebsd.org/mailman/listinfo/freebsd-doc
> > To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"


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

Re: FreeBSD web build failed on build-web.ysv.freebsd.org

[Benjamin Kaduk]

This looks like fallout from a Unicode apostrophe in the COMMENT for  the
recently-added x11-fonts/linden-hill.

I sent tobik@ (its committer) a note about it but failed to cc the list
here.

-Ben

On Mon, Jan 28, 2019 at 12:24:37AM +, User Www-data wrote:
> n-hill">linden-hill-g20110526 Digital version of Frederic 
> Goudy
>   
>  ^
> *** [x11-fonts.html] Error code 1
> 
> make[3]: stopped in /usr/local/www/build/head/ja_JP.eucJP/htdocs/ports
> --- master-index.html ---
> encoding error : input conversion failed due to input error, bytes 0xE2 0x80 
> 0x99 0x73
> encoding error : input conversion failed due to input error, bytes 0xE2 0x80 
> 0x99 0x73
> I/O error : encoder error
> master-index.xml:9593: parser error : Premature end of data in tag em line 
> 9593
> 26">linden-hill-g20110526  -- Digital version of Frederic 
> Goudy
>   
>  ^
> master-index.xml:9593: parser error : Premature end of data in tag p line 25
> 26">linden-hill-g20110526  -- Digital version of Frederic 
> Goudy
>   
>  ^
> master-index.xml:9593: parser error : Premature end of data in tag body line 
> 19
> 26">linden-hill-g20110526  -- Digital version of Frederic 
> Goudy
>   
>  ^
> master-index.xml:9593: parser error : Premature end of data in tag html line 
> 12
> 26">linden-hill-g20110526  -- Digital version of Frederic 
> Goudy
>   
>  ^
> *** [master-index.html] Error code 1
> 
> make[3]: stopped in /usr/local/www/build/head/ja_JP.eucJP/htdocs/ports
> 2 errors
> 
> make[3]: stopped in /usr/local/www/build/head/ja_JP.eucJP/htdocs/ports
> *** [all] Error code 2
> 
> make[2]: stopped in /usr/local/www/build/head/ja_JP.eucJP/htdocs/ports
> 1 error
> 
> make[2]: stopped in /usr/local/www/build/head/ja_JP.eucJP/htdocs/ports
> *** [all] Error code 2
> 
> make[1]: stopped in /usr/local/www/build/head/ja_JP.eucJP/htdocs
> 1 error
> 
> make[1]: stopped in /usr/local/www/build/head/ja_JP.eucJP/htdocs
> *** [all] Error code 2
> 
> make: stopped in /usr/local/www/build/head/en_US.ISO8859-1/htdocs
> 1 error
> 
> make: stopped in /usr/local/www/build/head/en_US.ISO8859-1/htdocs
>32.92 real15.47 user11.64 sys
> 
> latestrevision.timestamp "2019-01-27 01:50:51" 
> latestrevision.committer "kib"
> latestrevision.number "52784"
> ___
> freebsd-doc@freebsd.org mailing list
> https://lists.freebsd.org/mailman/listinfo/freebsd-doc
> To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"
___
freebsd-doc@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: Document Enhancement 2.3.1.1. Writing an Image File to USB

[Benjamin Kaduk]

On Sat, Jan 19, 2019 at 02:54:17PM +, Rob Hulley wrote:
> https://www.freebsd.org/doc/handbook/bsdinstall-pre.html 
> 
> 
> For OSX 
> 
> # dd if=FreeBSD-10.2-RELEASE-amd64-memstick.img of=/dev/da0 bs=1M conv=sync
> 
> Should read bs=1m or it will fail. (lower case m instead of upper case M)
> 
> It should be obvious from the error message but might help someone.

FreeBSD has, of course, accepted the uppercase letters as synonyms since
r132933 (July of 2004).  It seems that while Mac OS (at least on the High
Sierra I have handy) only accepts the minuscule 'm', Linux will only
accept the majuscule 'M' (!).

So it's probably more appropriate to make a note about the argument not
being fully portable than to try to adjust the example to work everywhere.

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

Re: Willing to help with documentation

[Benjamin Kaduk]

On Mon, Dec 17, 2018 at 01:55:07AM +0530, Nikolai Lvovich wrote:
> Hi.
> 
> I am new to the FreeBSD project (using since FreeBSD 11.1), and I use it as
> only desktop OS during my university research, for frankly, I am amazed by
> the quality and reliability of it, including the friendly handbook.
> 
> However, I notice a few outdated info now and then in both
> 
> 
>1. 1. FreeBSD handbook
>2. 2. FreeBSD developer's handbook.
> 
> 
> I am willing to help the project by updating the handbook. Please let me
> know if you guys are interested in my request :)

Generally we are, with the caveat that getting volunteers to have the time
to look at submissions can require persistence and manual pestering.
You'll likely want to read
https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/ and submit
some bugzilla entries
(https://bugs.freebsd.org/bugzilla/enter_bug.cgi?product=Documentation).
Feel free to hop on to #bsddocs on efnet as well, whether for
questions/discussion or to pester people to look at your patches.

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

Re: option sort order in usage/man pages/documentation

[Benjamin Kaduk]

On Thu, Aug 30, 2018 at 10:25:21AM -0400, Allan Jude wrote:
> On 2018-08-30 03:50, Yuri Pankov wrote:
> > Hi,
> > 
> > I'm working on some man page updates, and, thinking about consistency,
> > been wondering if there's any policy set on the order of options that
> > one should use in usage messages/man pages/other documentation, i.e. is
> > it 'ABCabc', 'AaBbCc', or 'aAbBcC' (or anything else really, I hope
> > 'unsorted' isn't possible answer here).
> > ___
> > freebsd-doc@freebsd.org mailing list
> > https://lists.freebsd.org/mailman/listinfo/freebsd-doc
> > To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"
> 
> It has definitely been policy to sort them alphabetically, but I don't
> know that that much attention has ever been paid to sorting upper and
> lower case characters.
> 
> ABCabc is right out, but I don't know what the right answer is between
> the other two. I would say humans sort lowercase first, but by ASCII the
> uppercase is first.

POSIX locale collation behavior is probably going to be the default winner
in this question.

Though I think there are some cases where it is better to group related
options than to globally do everything alphabetically.

-Ben


signature.asc
Description: PGP signature

Re: Status Update about effort to translate the FreeBSD Documentation from en_US to pt_BR

[Benjamin Kaduk]

On Sun, Aug 26, 2018 at 02:25:41PM -0300, Edson Brandi wrote:
> Hello Guys,
> 
> First of all, i'm sorry for the text wall... But I think it's worth
> sharing with you what we did in the last 2 weeks, because I believe
> that what we have learned can be useful to other translation groups.

I do, too -- that's a really cool story, and thank you for sharing it!

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

Re: Review of a handbook patch

[Benjamin Kaduk]

On Thu, Jul 19, 2018 at 08:43:17PM +0200, Rocky Hotas wrote:
> Hi!
> This is about the review:
> 
> https://reviews.freebsd.org/D10600
> (patch to LDAP section of the FreeBSD Handbook)
> 
> I wrote the text as a newbie, enthusiast user who tried to install an
> OpenLDAP server, found some difficulties, and wanted to contribute.
> 
> The style was naive and needed several corrections, that has been made
> for about the first half, now waiting for a feedback. I don't know
> anyone and lack some basic information. In order to avoid further
> errors, I would like to ask, about the review process itself:
> - Should the configuration presented in the text be tested by someone
> other than me?

That's not necessarily a requirement.  If it works for you and looks
reasonable, we don't need to hold up getting the documentation in (we can
always change it later if there's a bug report).

> - The role of the reviewer is only to notice the possible errors in the
> style or markup, or can a dialogue/discussion take place?

A discussion can definitely take place.  Some reviewers (e.g., me) may be
very busy and not effectively participate in such a dialogue, though,
unfortunately.

> - Till now, the linked text has been read by several developers, each of
> them finding some flaw, but not knowing the "history" of the issues and
> their evolution. Is this normal? How does the review process usually get
> coordination?

It is not uncommon to have different reviewers come in and be unaware of
the whole history.  Ideally a change would not be sitting around
uncommitted as long as this one has, but sometimes it happens.

It's sometimes easiest if there can be a single dedicated reviewer who
follows the change over time, participates in a dialogue, etc., but I don't
have any great tips for picking up such a reviewer.

> If someone could give some hint, I would be very grateful.

Hopefully this helps.  Thank you for submitting the patch and updating it
so much, and I'm sorry I can't help more right now.

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

Re: How to write an addendum to 22.2 Using Localization

[Benjamin Kaduk]

On Fri, Jan 05, 2018 at 10:10:49AM +, Vitalio D wrote:
> Hello doc team,
> 
> I'd like to write a short addendum or rewrite some subsections of 22.2 of 
> handbook concerning i18l. Since some time (since when ?) the vt has replaced 
> syscons as default, but the i18n section still based on syscons. Recently I 
> had some trouble with localizing my 11.1-STABLE terminal. More about this can 
> be found at 
> https://lists.freebsd.org/pipermail/freebsd-questions/2017-December/280129.html
>  mail thread.
> 
> The actual question is whether I should rewrite concerned subsections of 22.2 
> or rather add a new subsection to describe how I managed to configure vt?

Even though the oldest supported release (10.3) does include vt(4)
support, it's best to do this as a separate section, since
syscons(4) is still supported, too.  (Syscons provides a couple of
features that vt does not, and has some vocal supporters of those
features, who would probably not be happy to see the syscons
documentation go away.)

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

Re: Faizal Alfaritsy menambahkan foto baru

[Benjamin Kaduk]

On Sat, Dec 02, 2017 at 10:54:47PM -0500, Rick Miller wrote:
> I only recently subscribed to this list. It seems to see a lot of these
> messages. Is that the expected behavior?

No, it's not expected.  Someone(TM) should probably ask postmaster@
to take a look.

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

Re: Porters Handbook section 4.4

[Benjamin Kaduk]

On Thu, Oct 26, 2017 at 08:26:21PM -0700, Russell Haley wrote:
> Hello,
> 
> I'm still stuck building the new chapters I wrote for the Porters
> Handbook. I can't seem to get the system to "find" the file noted in
> my previous post:

Sorry I missed this the first time around.  It would be highly unexpected
if you needed to manually download chunk.xsl from sourceforge, so it may
be best to start off looking at your build environment with pristine sources.
So, maybe snag a fresh copy and don't patch it at all yet.
Do you have the 'docproj' port/package installed already? (textproc/docproj)
Then you should be able to follow the
https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/ and
try to get the pristine sources building.

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

Re: [PATCH] Fix jail(8) manpage.

[Benjamin Kaduk]

On Wed, Oct 18, 2017 at 01:15:27PM -0700, Steve Kargl wrote:
> According to src/UPDATING,
> 
> 20110930:
> sysinstall has been removed
> 
> The following patch changes jail(8) to refer instead to bsdinstall.
> 
> Index: jail.8
> ===
> --- jail.8(revision 324728)
> +++ jail.8(working copy)
> @@ -1006,7 +1006,7 @@
>  .Pp
>  Assuming no errors, you will end up with a shell prompt within the jail.
>  You can now run
> -.Pa /usr/sbin/sysinstall
> +.Pa /usr/sbin/bsdinstall

r324732, thanks.  (3-day MFC timer.)

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

Re: Porters Handbook section 4.4

[Benjamin Kaduk]

On Wed, Oct 11, 2017 at 11:23:58AM -0700, Russell Haley wrote:
> Here is chapter 1 in an odt since it's a new work and I wanted to bang
> it out without formatting. I'll add it to the sources after I get a
> good start on Chapter 2 and post a patch. I assume phabricator the
> preferred tool for commenting on documents?

No harm in banging it out without formatting (nothing wrong with 
plain-old-UTF-8,
even).

Phabricator is the preferred tool, yes.  It will take me a few days to
have a chance to look, most likely.

Thanks again,

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

Re: wireless network driver "urtwn"

[Benjamin Kaduk]

On Sat, Oct 07, 2017 at 11:09:30PM +0200, Patrik Horst wrote:
> Hi,
> 
> I'm refering to "https://www.freebsd.org/releases/11.0R/hardware.html":
> The wireless network driver "urtwn" also supports "Asus USB-N13, rev. B1".
> 
> Maybe you want to expand the documentation.

The release notes are fixed when the release is made, so that page
cannot be updated.

But, the supported hardware list is autogenerated from the corresponding
man page, so I have added this device to the appropriate list in r324458.

Thanks for the submission!

-Ben

> God job on ver. 11 of FBSD, keep on!
___
freebsd-doc@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: Porters Handbook section 4.4

[Benjamin Kaduk]

On Mon, Oct 09, 2017 at 12:22:11AM -0700, Russell Haley wrote:
> On Mon, Oct 2, 2017 at 9:21 AM, Russell Haley  wrote:
> > On Fri, Sep 29, 2017 at 7:58 AM, Warren Block  wrote:
> >> On Mon, 25 Sep 2017, Russell Haley wrote:
> >>
> >>> Thanks! I'll play with this on the weekend.
> >>
> >>
> >> Please create a review at https://reviews.freebsd.org/ and add me as a
> >> reviewer.
> >>
> >> Thanks!
> >
> > Will do. Just a progress update: I got the handbook sources and found
> > the section in chapter.xml. I created a Geany project with everyone's
> > raw notes and the sources. To be continued...

IIRC Warren had volunteered to help get that text committed, but if
not, feel free to add me to the phabricator review when it's ready.

> 
> Hi,
> 
> So I got a good chunk of work done moving koobs’ description into the
> correct format and then started looking at how everything hangs
> together. I don’t want to offend anyone on this list, but I think the
> organisation and some of the English in the first 4 chapters needs
> work. I know how hard it is to create content from nothing (and how
> easy it is to be critical), so my hat is off to the original content

Given how deep a tangle of patchwork and incremental change on top of
incremental change it is, it's unsurprising that the overall organization
of things does not make the best of sense.

> creators. However, what I would like to propose is this:
> 
> 1) Re-write the introduction to describe what the ports system is and
> point to the correct references in the handbook for running ports. I
> would also include reference to how to use subversion (handbook) and
> the correct repository names. I would also point users to websvn. I
> would indicate that the pkg system works off of the ports and include
> some other helpful links such as freshports, github and the build
> system. I would include a paragraph about how bugillza can be searched
> for issues for ports and also describe how phabricator is used to
> submit new patches to the ports system. Finally, it should be
> emphasised that anyone can create a new port for their software and
> submit it to the system.
> 
> 2) The second chapter should be a description of how the ports system
> works. This description can be found in the how things work section of
> chapter 4. Include further description of the make files and where
> they can be found. A note should be made that while the makefiles are
> source code, they are well documented at the top and can be referenced
> when needed for more information. Chapter 2 should describe how
> additional targets can be created (content also from chapter 4).
> 
> 3) Chapter 3 should remain and should be renamed Port Files Overview
> (or something to that effect). The first page should outline the files
> and involved. Most of them are quite simple and dedicating an entire
> ‘section’ to each step is cumbersome. Section 3.1 and 3.2 should be
> combined and beefed up (not sure the name yet). Section 3.3. and 3.4
> should be combined and called Validation and Verification (or
> something to that effect). A description of what portlint does should
> be added. The  new "V" section should describe why testing is
> important and what things to pay attention to, as well as reference
> the do’s and don't s section.
> 
> 4) Chapter 4 should be called adding or updating ports. It should
> briefly describe what should be done to create a new port and then
> describe the processes as outlined by koobs'. The manual porting
> instructions should be removed.
> 
> If there is any interest in me doing this, please speak up now as I
> might be able to take a day off this week and bash it out in one
> sitting. Okay, it's late...

This sounds like a pretty good strategy, especially the part where
we actually introduce the subject matter!

I don't want to tell you to take a day off, but would be happy to
see something like this appear eventually.

Thanks for putting these thoughts together,

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

Re: why recommend "portmaster -af" for full port rebuild?

[Benjamin Kaduk]

On Mon, Jul 31, 2017 at 02:55:31PM +, Andrew Hamilton-Wright wrote:
> 
> Dear FreeBSD Docs,
> 
> On the upgrading/updating page:
> https://www.freebsd.org/doc/handbook/updating-upgrading-freebsdupdate.html
> there is a line that recommends using
> portmaster -af
> to rebuild all of the ports.  There is even a recommendation that '-G' be 
> added to avoid interaction involving configuration screens.
> 
> This, however, ignores the many other interactions that portmaster still will 
> require.
> 
> Is there no way to rebuild the ports without interaction?  It seems that even 
> with
> portmaster -afG --no-confirm -y
> I still get a long parade of interaction requests -- far more than I would if 
> I used portupgrade.
> 
> I will note that Doug Barton, the author of portmaster, seems to advise 
> against using it in this form, as noted in this thread:
> https://lists.freebsd.org/pipermail/freebsd-stable/2009-August/051623.html
> 
> 
> Why is portmaster being recommended on this page, and if this is the best 
> option, why is there no discussion of the many interactions that will be 
> required (in spite of the implication of the discussion of the '-G' option)?

Does this hold even when one picks one of -D or -d?  (I mostly assume that
it is implicitly expected that any portmaster user will get so frustrated
by those prompts that they set an appropriate configuration entry to
make them automatically.)

Regardless, it may be worth considering documenting poudriere over
portmaster or other alternatives, as I'm given to understand that it
presents a smoother experience.

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

Re: FreeBSD Day in Yerevan

[Benjamin Kaduk]

On Fri, Jun 16, 2017 at 10:51:20AM +0400, Antranig Vartanian wrote:
> Hi Ben! thanks for the reply!
> 
> yes, I just made this event link,
> https://www.facebook.com/events/113662152573216/?active_tab=about
> is it better? :)

Yes, thanks!

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

Re: FreeBSD Day in Yerevan

[Benjamin Kaduk]

On Thu, Jun 15, 2017 at 10:02:53PM +0400, Antranig Vartanian wrote:
> Hi all!
> 
> I'm organizing FreeBSD Day in Yerevan, Armenia. there's gonna be a
> install-a-thon, presentation, pizza and juice.
> 
> June 19, 2017 at IBM Innovative Solution & Technologies Center, Alek
> Manukyan 1, YSU 7th building 6th floor, 0025 Yerevan, Armenia. 6PM AMT

Hi Antranig,

Is there a better URL for the event than
https://www.facebook.com/istc.ibm.eif/ ?

Thanks,

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

Re: handbook TOC

[Benjamin Kaduk]

On Sun, May 28, 2017 at 11:31:15AM -0400, Ernie Luzar wrote:
> Been working on updating a chapter in the English version of the 
> handbook. I deleted a section from the chapter.xml file and now keep 
> getting an error code 4 from the "make".

Without looking at the actual patch and build log in question, my
guess would be that here is something somewhere else in the handbook
that tries to refer to the now-deleted section (by id) producing the
error.

> How is the TOC [table of contents] built?
> Is it a file that contains all the chapter sect headers?
> When I delete a section from a chapter do I also have to remove said 
> section header from some file that the build of the TOC uses?

I do not believe you need to delete a section header from the TOC
specifically when deleting a section.  But, the XML id for that
section may be referenced from a different part of the document, so
it would be worth grepping through to see if it is still referenced.


> The igor pgm  does not seem to test for open and close of sections 
> headers like it does for other tags. Is there some reason for this?

I don't know, sorry.

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

Re: having trouble making changes to the handbook

[Benjamin Kaduk]

On Sat, May 20, 2017 at 09:17:47AM -0400, Ernie Luzar wrote:
> I am following the info in this link
> https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/
> 
> I installed the textproc/docproj package.
> 
> The above link says that svn is installed as part of that port. But it 
> really is not. Have to use the built in svnlite command.

It seems that
https://svnweb.freebsd.org/ports/head/textproc/docproj/Makefile?revision=420130=markup
has some logic to not depend on devel/subversion when
/usr/bin/svnlite is present in the build environment, which is
arguably not the best choice, since the build environment need not
match the install environment when pre-built packages are in use.


> The shown command
>"svnlite checkout https://svn.FreeBSD.org/doc/head ~/doc"
> downloads far more items than wanted. This needs better example of just 
> downloading the desired language version of the handbook plus any 
> "shared directories" required for "make command" to work. How do I do this?

It is intentionally undocumented, as there are multiple parts from
the root needed to build a translation tree (in addition to the
english sources, which are used when translations do not exist).
No one has gone through to enumrate the list and commit to keeping
it up to date as the build system changes.  That is to say, you are
free to attempt it, but it will require some investigation and it
will probably be simpler overall to just accept the extra bytes as
the cost of convenience.


> I ran the "igor -R filename.xml | less -RS" command on the chapter I 
> wanted to work on before making any changes. To my surprise a bunch of 
> error are shown. Since these error are all already in the handbook 
> source I see no reason why I should try to correct them.

Just because errors are preexisting they should be ignored instead
of fixed?  To be clear, no one is going to insist that you fix all
issues in a file before adding content to it, but it is also a fine
idea to make an initial cleanup patch before starting to do further
work.

As to how this situation might arise, the existing content is often
quite old, and igore is a comparatively new tool (and continues to
receive updates), so it is not surprising that there is old content
that does not fully comply to the current standards.

> When I ran the "make" command the resulting html files are just written 
> into the directory that "make" was run from. How do I tell "make" to 
> write the output to a location of my selection?

'make install' should respect DESTDIR, of course, and I think (but
did not test) that the usual OBJDIR-manipulation variables would
work.

> What is really lacking is a way to view the changed output in a command 
> line browser. Installing a desktop just to view the changed handbook is 
> not an acceptable solution.

But, what would the other location of your selection be that would
be differently viewable in a command-line browser than the html
files in the build tree?  I generally use a browser (desktop or not)
to view the html files next to the xml sources, which is usually
"good enough" for what I need to do.

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

Re: The future of the roff toolchain

[Benjamin Kaduk]

On Sun, May 21, 2017 at 02:57:33PM +0200, Baptiste Daroussin wrote:
> 
> What I want to propose now, it to render them as PDF (html?) once and push 
> them
> somewhere (to be defined) as static document on our documentation website.
> Please doceng@ provide me a location where to push them.
> 
> And then remove bsd.doc.mk from FreeBSD 12.0 along with the removal of groff.
> I also want to remove most of roff related tools (the one provided by 
> toolchains
> available in ports) for which we kept a BSD version (not really maintained in
> base):
> namely:
> - checknr
> - vgrind
> - colcrt
> 
> Only keeping:
> - col (useful in other places than roff)
> - soelim (also used for manpages and we have a clean BSD licensed version 
> which
>   is also now parts of mandoc)

That sounds like a good plan to me.  Thank you for putting in all
the time trying out the alternate roff toolchains!

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

Re: FreeBSD Handbook - LDAP section

[Benjamin Kaduk]

On Wed, May 03, 2017 at 02:46:52PM +0200, Rocky Hotas wrote:
> Hi!
> This section about LDAP of the FreeBSD Handbook
> 
> https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/network-ldap.html
> 
> is outdated and with several errors. For the first half, the structure of the 
> guide can be preserved, but the remainder needs a complete rearrangement. 
> There are also some pieces of configuration files to be commented and 
> included as examples, so the new text needs to be properly formatted.
> Is the Bug report still the correct way to propose such a correction? And if 
> not, who can I contact or where can I post my modifications?

Bug reports are fine, but you could also create an (account and)
entry on https://reviews.freebsd.org/ to facilitate review of the
patch.

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

Re: Spelling mistake in the Handbook

[Benjamin Kaduk]

On Sun, Mar 12, 2017 at 11:29:17PM -0400, Casey Timmers wrote:
> 4.4.1, sentence after the first code example, last word, "succeed".

Fixed in r50053.  (It will take some minutes for the website
rebuild cron job to pick it up.)

Thanks!

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

Re: Fwd: 28.10. File and Print Services for Microsoft® Windows® Clients (Samba)

[Benjamin Kaduk]

On Thu, Mar 02, 2017 at 12:23:32PM +0200, Boyko Yordanov wrote:
> Hi,
> 
> there’s a typo - a space is missing here
> 
> This allows the administrator to create SMB/CIFSshares on the FreeBSD
> 
> I assume it should be SMB/CIFS shares
> 
> https://www.freebsd.org/doc/handbook/network-samba.html 
> 

Fixed in r50027 (will take some minutes to make its way onto the
website).

Thanks for the report,

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

Re: Mellanox as an HW vendor in FreeBSD 9.x (and above) HW notes

[Benjamin Kaduk]

Hi Meny,

Sorry to hear that you didn't get a response.  We always recommend using the
role address since that ensures that everyone stays in the loop, but that
of course does not stop someone from noting the existence of
https://www.freebsd.org/administration.html

I am quite overbooked at the moment, so unfortunately I cannot take on the
role of advocating for this change, myself.

-Ben

On Sun, Jan 29, 2017 at 01:07:02PM +, Meny Yossefi wrote:
> Thanks Ben.
> 
> I got no response from re@Freebsd. 
> 
> Is there a specific person you can refer me to? 
> 
> -Meny
> 
> 
> -Original Message-
> From: Benjamin Kaduk [mailto:ka...@mit.edu] 
> Sent: Sunday, January 15, 2017 11:42 PM
> To: Meny Yossefi <me...@mellanox.com>
> Cc: d...@freebsd.org; Hans Petter Selasky <ha...@mellanox.com>; 
> r...@freebsd.org
> Subject: Re: Mellanox as an HW vendor in FreeBSD 9.x (and above) HW notes
> 
> On Sun, Jan 15, 2017 at 03:38:06PM +, Meny Yossefi wrote:
> > Hi,
> > 
> > My name is Meny and I'm leading Mellanox's FreeBSD team these days, 
> > developing Ethernet and InfiniBand drivers for our ConnectX NICs.
> > 
> > We came across the FreeBSD 11.0 hardware notes and found that we were not 
> > included in the list although we have an Ethernet and InfiniBand driver 
> > since FreeBSD 9.1.
> > 
> > https://www.freebsd.org/releases/11.0R/relnotes.html
> > 
> > 
> > Can you please let me know what is the procedure for adding us as a vendor?
> 
> As I understand it, the hardware notes are generated automatically via 
> certain portions of certain manual pages.
> 
> It looks like that takes the form of ; entities in
> (e.g.) ^/base/head/release/doc/en_US.ISO8859-1/hardware/article.xml, with the 
> hwlist entities being generated by 
> ^/base/head/release/doc/share/misc/man2hwnotes.pl.  I don't know offhand 
> whether mlx5en.4 is formatted properly for that script, but it seems that at 
> a minimum, the  entity needs to be added to the release notes 
> sources.
> 
> I've cc'd r...@freebsd.org, since they have change control over the release 
> notes and would need to make or approve such a change.
> 
> -Ben
___
freebsd-doc@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: Enabling PF

[Benjamin Kaduk]

On Sun, Jan 29, 2017 at 04:37:36PM -0600, Michael Keen wrote:
> In 29.3.1. Enabling PF there is a reference to a default ruleset 
> already created at /etc/pf.conf. In my install of FreeBSD 11 there is 
> not a default ruleset there. The link to the pf tutorial at the top of 
> Chapter 29 suggests that "on FreeBSD, you'll need to create a 
> /etc/pf.conf file yourself." I'm just learning about FreeBSD and pf so 
> maybe I have misconfigured something, or the documentation may need to 
> be updated.

It looks like that pf.conf was moved to the examples directory in r173536
and can be found in /usr/share/examples/pf/pf.conf ; the documentation has
yet to be updated to that change, even 9 years later :(

Please feel encouraged to file a bug report at https://bugs.freebsd.org
so that the issue can be tracked.

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

Re: handbook chapter 14. Jails is out of date

[Benjamin Kaduk]

On Thu, Jan 19, 2017 at 12:03:45PM +0800, Ernie Luzar wrote:
> 
> I hope someone will work on this to make it happen.
> 
> Ya I know, patches are welcome.

Not just patches but entries in the bug tracker as well:
https://bugs.freebsd.org/

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

Re: Mellanox as an HW vendor in FreeBSD 9.x (and above) HW notes

[Benjamin Kaduk]

On Sun, Jan 15, 2017 at 03:38:06PM +, Meny Yossefi wrote:
> Hi,
> 
> My name is Meny and I'm leading Mellanox's FreeBSD team these days, 
> developing Ethernet and InfiniBand drivers for our ConnectX NICs.
> 
> We came across the FreeBSD 11.0 hardware notes and found that we were not 
> included in the list although we have an Ethernet and InfiniBand driver since 
> FreeBSD 9.1.
> 
> https://www.freebsd.org/releases/11.0R/relnotes.html
> 
> 
> Can you please let me know what is the procedure for adding us as a vendor?

As I understand it, the hardware notes are generated automatically via
certain portions of certain manual pages.

It looks like that takes the form of ; entities in
(e.g.) ^/base/head/release/doc/en_US.ISO8859-1/hardware/article.xml, with
the hwlist entities being generated by
^/base/head/release/doc/share/misc/man2hwnotes.pl.  I don't know offhand
whether mlx5en.4 is formatted properly for that script, but it seems that
at a minimum, the  entity needs to be added to the release
notes sources.

I've cc'd r...@freebsd.org, since they have change control over the release
notes and would need to make or approve such a change.

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

Re: FreeBSD 11.0-RELEASE upgrading comments

[Benjamin Kaduk]

On Mon, Jan 09, 2017 at 07:26:41PM -0500, Eric Rucker wrote:
> Ben,
> 
> I've already upgraded to 10.3-RELEASE, and do not have uname -a output
> available from the system before the upgrade. But, this should be good
> enough, from the last kernel log from before I upgraded:
> 
> +FreeBSD 9.3-RELEASE-p49 #0: Fri Oct 21 21:01:08 UTC 2016
> +r...@amd64-builder.daemonology.net:/usr/obj/usr/src/sys/GENERIC amd64
> 
> I was at the latest patchlevel (p53 - p49 was the last kernel
> patchlevel, it appears) before attempting the upgrade.

Okay, thanks for the confirmation.
Unfortunately, it is not always easy to change the release notes after
the release is finalized, but we can see what could be done.

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

Re: FreeBSD 11.0-RELEASE upgrading comments

[Benjamin Kaduk]

On Mon, Jan 09, 2017 at 08:13:06AM -0500, Eric Rucker wrote:
> Hello,
> 
> I've noticed that I was unable to perform an upgrade directly to
> FreeBSD 11.0-RELEASE from 9.3-RELEASE by following the directions in
> this document: https://www.freebsd.org/releases/11.0R/installation.html
> 
> Upon attempting to run freebsd-update upgrade -R 11.0-RELEASE, I
> received the error "The update metadata is correctly signed, but
> failed an integrity check." I received no such error going to
> 10.3-RELEASE instead.
> 
> Is this a bug, or a documentation error?

I am more inclined to suspect documentation error, in that IIRC there
was an errata notice relating to how integrity checks were done on updates,
which was needed in order to update past a version boundary in that range.

Are you at the latest 9.3 patchlevel already?  If not, it's probably best
to take all available updates within 9.3 before attempting the major version
upgrade.  (That is, please show the `uname -a` output from the system
in question.)

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

Re: cupsd.conf JobRetryLimit =0 not mentioned in documentation

[Benjamin Kaduk]

On Mon, Jan 02, 2017 at 03:18:26AM +0100, Jens Redecker wrote:
> Hi there,
> 
> 
> the documentation of cupsd.conf 
> https://www.freebsd.org/cgi/man.cgi?query=cupsd.conf mentions
> "

The cupsd.conf manual page comes from the ports collection, and as such
it is maintained by the cups project, not the FreeBSD project.  It's probably
best to file a report at the cups project and let the update trickle back
into FreeBSD with a new upstream version.

Google suggests that https://github.com/apple/cups/issues is a good place
to submit such a report.

Thanks,

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

Re: FreeBSD Handbook A.3.6 has incorrect (old?) cert-fingerprint info for svn.freebsd.org

[Benjamin Kaduk]

On Tue, Dec 27, 2016 at 08:34:00AM -0500, Michael C Voorhis wrote:
> The FreeBSD handbook section A.3.6, under
> 
>   https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/svn.html
> 
> lists certificate fingerprints which appear to be outdated.  It
> appears that the SHA1 fingerprint, listed in the handbook as
> 
>E9:37:73:80:B5:32:1B:93:92:94:98:17:59:F0:FA:A2:5F:1E:DE:B9
> 
> Should be
> 
>86:5C:C5:84:F5:2D:40:FA:C6:F9:F0:D9:F5:40:D0:D5:6B:90:CB:CE .
> 
> Similarly, the SHA256 fingerprint listed on the handbook-page is
> 
>
> D5:27:1C:B6:55:E6:A8:7D:48:D5:0C:F0:DA:9D:51:60:D7:42:6A:F2:05:F1:8A:47:BE:78:A1:3A:72:06:92:60
> 
> where it should be
> 
>
> 3D:68:44:40:22:B1:96:B2:D3:0B:DD:1A:C9:AA:FF:CB:EC:89:FE:A2:4B:AF:11:F9:7C:AD:D9:F2:67:B7:35:18
>  .
> 
> According to my web-browser, the cert has been in place since 14 June
> 2016, and will expire on 29 June 2017.

The fingerprints you quote are preceded by a note:

% Note: The FreeBSD Subversion mirrors previously used self-signed SSL 
certificates
% documented in this chapter. As of July 14, 2015, all mirrors now use an 
official
% SSL certificate that will be recognized by Subversion if the 
security/ca_root_nss
% port is installed. The legacy self-signed certificates and server names are 
still
% available but are deprecated and no longer supported.

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

Re: Is there a possibility to obtain the most recent FreeBSD documentation in .pdf format?

[Benjamin Kaduk]

On Fri, Dec 02, 2016 at 10:56:19PM +0100, John W. Kitz wrote:
> Hi,
> 
>  
> 
> I was wondering; most books on FreeBSD that are on the market at any one
> time are typically based on a release that is quite a bit older than the
> most recent GA'd one. Obviously there is the HTML version online, but I
> prefer to use a book or a printed manual.
> 
>  
> 
> Is there a possibility to obtain the most recent FreeBSD documentation in
> .pdf format, either by means of downloading it or by e.g. using some tool to
> generate it from the HTML version?

https://www.freebsd.org/doc/en/books/fdp-primer/ has instructions for building
the FreeBSD documentation; the extremely abridged version is roughly:

pkg install docproj
svn co https://svn.freebsd.org/doc/head doc
cd doc
make FORMATS=pdf ENGLISH_ONLY=yes

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

Re: This article by nasa might be worth mentioning in "in the press"

[Benjamin Kaduk]

On Thu, Nov 24, 2016 at 01:12:15PM +, Vincent Hoffman-Kazlauskas wrote:
> https://www.nas.nasa.gov/SC16/demos/demo9.html

Yes, it probably is worth including; thanks for the pointer.

There are some stale instructions to doc committers in the relevant source
file and I'm trying to settle what the current version of the instructions
should be before committing anything...

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

Re: Updating the ieee80211(9) manual page

[Benjamin Kaduk]

On Thu, Nov 10, 2016 at 09:59:23PM +, Fehmi Noyan ISI via freebsd-doc wrote:
> Hiya,
> 
> I am considering to update ieee80211(9) manual page with function call 
> definitions found in NetBSD ieee80211(9) manual[1]. Many functions, such as 
> ieee80211_mhz2ieee() ,are defined in sys/net80211/ieee80211.c and are also 
> available in FreeBSD.
> 
> Would ;
> 
> 1 ) Updating the manual page locally
> 2 ) Generating a diff file against the -CURRENT
> 3 ) Submitting a bug report along with the diff file
> 
> be the proper approach to get the thing done?

Yes.

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

Re: samba44

[Benjamin Kaduk]

On Tue, 25 Oct 2016, Jakob Breivik Grimstveit wrote:

> https://www.freebsd.org/doc/handbook/network-samba.html should point
> to net/samba44, not net/samba43?

Can you say a bit more about why?  net/samba43 still exists and is not
marked DEPRECATED and seems like it will have a few more months of
security support from upstream.

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

Re: An error in Handbook IPFW example

[Benjamin Kaduk]

On Sat, 8 Oct 2016, Petri Riihikallio wrote:

> About half way through 
> https://www.freebsd.org/doc/handbook/firewalls-ipfw.html it says:
>
> > # Allow outbound NTP
> > $cmd 00260 allow tcp from any to any 37 out via $pif setup keep-state
>
> But that doesn’t allow NTP. NTP uses UDP 123. TCP 37 is the obsolete TIME 
> protocol. (Unless I am completely at a loss, of course.)

It is probably best to report the issue at
https://bugs.freebsd.org/bugzilla/ so it will still be known even if no
one patches it right away.


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

Re: non absolute path in hier(7) manual page

[Benjamin Kaduk]

On Thu, 22 Sep 2016, Teng Zhang via freebsd-doc wrote:

> hi, the relative path in hier(7)  becomes very inconsistent for me when
> one directoryincludes too much sub-directory, sometimes i can't figure
> out the sub-directory belongsto whom.so, change the relative path to
> absolute path will be a good idea ?

Well, there are competing concerns between clarify and avoiding clutter,
and the goals being optimized for in a manual page are "reference
document" (as opposed to "introductory documentation").  But it's probably
worth thinking about; can you file an entry at
https://bugs.freebsd.org/bugzilla/ ?

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

Re: [PATCH] Fix markup in sntp.8

[Benjamin Kaduk]

On Tue, 23 Aug 2016, Benjamin Kaduk wrote:

> On Tue, 23 Aug 2016, Steve Kargl wrote:
>
> > On Wed, Aug 17, 2016 at 01:47:37PM -0700, Steve Kargl wrote:
> > > Index: sntp.8
> > > ===
> > > --- sntp.8  (revision 303492)
> > > +++ sntp.8  (working copy)
> > > @@ -213,7 +213,7 @@
> > >  more than enough for a unicast response.  If \fBsntp\fP is
> > >  only waiting for a broadcast response a longer timeout is
> > >  likely needed.
> > > -.It  Fl \-wait , " Fl \-no\-wait"
> > > +.It  Fl \-wait , Fl \-no\-wait
> > >  Wait for pending replies (if not setting the time).
> > >  The \fIno\-wait\fP form will disable the option.
> > >  This option is enabled by default.
> > >
> >
> > Does freebsd-doc handle documentation patches?
>
> We do handle them, we are just sometimes slow about it.

Getting around towards doing so, I note that this file is from a vendor
tree, and the bug is still present in
https://github.com/ntp-project/ntp/blob/master/sntp/sntp.mdoc.in .
Unfortunately, http://bugs.ntp.org/enter_bug.cgi wants me to create a
login; adding cy and delphij to see if either of them already have one and
would be able to report the bug upstream.

My understanding is that now that we're in subversion intsead of CVS,
applying a local patch to a file from the vendor tree is not a huge
burden, but I'm inclined to wait a bit to add a local patch so we can see
how responsive upstream is.

Sorry about the (further) delay...

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

Re: FreeBSD Man Pages: MAKE(1) -- Word Document Attached

[Benjamin Kaduk]

On Tue, 16 Aug 2016, Dennis Jensen wrote:

> Here is my finished word document of this with all my corrections put into 
> place in case this helps facilitate with getting the corrections put into 
> place.

Unfortunately, the mailing list strips attachments before distributing the
message.  It may be best to report an issue at
https://bugs.freebsd.org/bugzilla/ and attach the file there, though it is
quite atypical to edit man pages in Word.  The authoritative source
version is plain text using the mdoc markup language for formatting, so
text editors (as opposed to word processors) are more common.

Furthermore, the make manual lives in the contributed tree
(https://svnweb.freebsd.org/base/head/contrib/bmake/make.1?view=markup),
for which it is frequently best to try to make changes in the upstream
location first, and only make FreeBSD-local patches if that is
unsuccessful.

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

Re: Typo on the mailing list "Browse" page...

[Benjamin Kaduk]

On Fri, 5 Aug 2016, Chris Watson wrote:

> Folks,
>
> There is a very minor typo that I have been staring at since it was
> created when 11-STABLE was branched.
>
> One the following page: https://docs.freebsd.org/mail/
>
> Towards the bottom "svn-src-stable-10" is listed twice. I am guessing a
> copy/paste error. The first one is correct the second one should be
> corrected to display "svn-src-stable-11".

It looks like that webpage may not generated from the documentation svn
repository ... looping in postmaster@ in case they know.

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

Re: Possible typo in handbook

[Benjamin Kaduk]

On Thu, 21 Jul 2016, Daniel Li wrote:

> Hi there,
>
> On the handbook page for sudo
> , I believe
> NOPASSWORD should be NOPASSWD.  Using the former gives a syntax error in
> visudo; the latter is accepted as correct.

You are correct; fixed at r49147 and should appear on the website within
the hour.

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

Re: Missing links on 10.3 Installation Instructions page

[Benjamin Kaduk]

Adding re, dropping -stable, since this is in the release documentation.

(There are  elements but no body of them to actually render.)

-Ben

On Fri, 15 Jul 2016, Nathan Bosley wrote:

> Hello,
>
> I had a glance at https://www.freebsd.org/releases/10.3R/installation.html.
>
> I believe this line is missing a couple of links:
> "The procedure for doing a source code based update is described in and ."
>
> My guess is that that line should be:
> "The procedure for doing a source code based update is described in
> Synchronizing
> Source
> 
>  and Rebuilding world
> 
> ."
>
> Thanks.
> ___
> freebsd-doc@freebsd.org mailing list
> https://lists.freebsd.org/mailman/listinfo/freebsd-doc
> To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"
>
___
freebsd-doc@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: Error in 10.3 errata doc

[Benjamin Kaduk]

On Wed, 6 Apr 2016, Jakob Breivik Grimstveit wrote:

> http://www.freebsd.org/releases/10.3R/errata.html says "svnlite co svn://
> svn.freebsd.org/base/releng/10.2 /usr/src"
>
> I would assume this should reference 10.3 instead.
>
> You fix? :-)

I think that the errata page is controlled by the release engineering
team; looping them in.

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

Re: Suggestion for addition to FreeBSD Handbook; 5.6. The X Display Manager

[Benjamin Kaduk]

Was there supposed to be an attachment containing the proposed patch?
This mailing list removes attachments before delivering the message.

-Ben

On Tue, 23 Feb 2016, sid -- wrote:

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

Re: 17.12. Encrypting Disk Partitions

[Benjamin Kaduk]

On Fri, 19 Feb 2016, christian.djuml...@yahoo.de wrote:

> Hello freeBSD-Team,
> I believe there is an error in the chapter on disk encrpytion (geli-part).
> In the suggested edits to rc.conf, the flags contains -p."-p" means "do not 
> ask for a passphrase", but the text above works with a passphrase. So this is 
> inconsistent and will result in a broken boot sequence.
> Although the error was not too hard to spot, such recipes should give a 
> consistent script to play along ... and avoid resulting in a broken system.
> Hope you agree and can fix this soon.Nevertheless, a very helpful section :-)

Good catch!  Thanks for reporting it; I have removed the -p from the
rc.conf snippet in r48243, which should appear on the live website in a
few tens of minutes.

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

Re: error 404 from wiki.freebsd.org/pkgng#Resources – pres-pkgng-bsdcan.pdf not found

[Benjamin Kaduk]

On Thu, 31 Dec 2015, Graham Perrin wrote:

> https://wiki.freebsd.org/pkgng#Resources refers to
> http://people.freebsd.org/~bapt/pres-pkgng-bsdcan.pdf
>
> That's not found. Instead,
>
> https://people.freebsd.org/~bapt/pres/pres-pkgng-bsdcan.pdf

Updated; thanks for the report.

-Ben

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

Re: Documentation on NFS Exports is wrong

[Benjamin Kaduk]

On Fri, 18 Dec 2015, Sebastian Schaack wrote:

> Hello,
>
> I’m new to freebsd an read the handbook a lot. Thank you , for this great 
> work.
>
> Yesterday I setup a nfs server and tried to export /home like it is mentioned 
> in the documentation.
>
> But after restarting the mountd service. It  reported an error in 
> /etc/exports . I red several other blogs and finally I got it.
>
> FreeBSD doesn’t allow to export symlinks . You have to export the real path 
> which is /usr/home/ . After changing the entry , everything worked well !
>
> I think the example on Chapter 28.3.1 /home -alldirs 10.0.0.2 10.0.0.3 
> 10.0.0.4 should be changed, because it is not working anymore.
>
> Please correct me if I’m wrong.

You are correct -- thanks for the report; I've committed a fix just now as
r47889.

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

Re: https://www.freebsd.org/doc/en/articles/committers-guide/pgpke ys.html

[Benjamin Kaduk]

On Thu, 22 Oct 2015, Kurt Lidl wrote:

> Greetings,
>
> In this document, it suggests running "gpg --gen-key".
>
> As of today's version of gnupgp:
>
> lidl@hydra-129: gpg --version
> gpg (GnuPG) 2.1.8
> libgcrypt 1.6.3
>
> The dialog that is presented doesn't give the option for
> specifying keylength, expiration date, etc.
>
> To get the dialog that is shown in the web page, you must
> issue: "gpg --full-gen-key"

Thanks for the repor; I updated the document to use --full-gen-key so as
to be consistent with the following transcript, in r47661.

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

Re: Old Items

[Benjamin Kaduk]

On Tue, 20 Oct 2015, Russell Haley wrote:

> Hey, I'm just browsing through bugzilla and I see that about half of the
> open items for documentation are from before 2014. Is there any plan to
> clear those items?

They are sitting in bugzilla so that when a commiter has time to actually
work on them, they are easy to find.  So, there is no concrete plan to
clear old documentation PRs at any specific time, no, though we would like
to see it happen.

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

Re: freebsd-update for jails built after "Updating Multiple Jails"

[Benjamin Kaduk]

On Fri, 16 Oct 2015, User Phryk wrote:

> PS: I found this mail address below the documentation, not sure if its
> an ML i need to join - if so please don't hesitate to tell me to join
> so this question can be answered publicly.

I think https://lists.freebsd.org/mailman/listinfo/freebsd-questions is a
somewhat better place to ask this quesion; the freebsd-doc list is for
making updates to the documentation.  But, I think I have an answer for
you here anyway.

>
> I set up my jails like described in [1].
>
> My setup differs a tiny bit in directory naming, and the fact
> that I've foregone creating skel/etc/make.conf because I'm
> using a central poudriere installation for all my port-building
> needs. I am assuming this doesn't change anything for updating
> the basesystem, but please do correct me if I'm wrong.
>
> I can update the packages just fine using "pkg upgrade -j",
> but I'm kind of at a loss on what the equivalent of doing the
> "freebsd-update fetch/install" and "freebsd-update upgrade -r"
> procedures is for these kinds of jails.
>
> I've already searched through the docs and asked in freenode/#freebsd a
> number of times, but sadly nobody seemed to be able to answer my question…
>
> I'm strongly suspecting that "freebsd-update" is not the way to go and
> that I have to have my machine compile the basesystem itself.

Indeed, freebsd-update works based on binary diffs, so you need to have
started from an official release install medium in order to use it.
(Well, or go through a lot of effort to set up your own freebsd-update
build environment, which seems overkill here.)

> Is this the case? And if so, do I just need to follow[2] and then
> do "make installworld DESTDIR=/my/jailroot"?

Basically, yes.  DESTDIR need not be set for buildworld, and does need to
be set for installworld.  I normally end up re-running 'make distribution
DESTDIR=/my/jailroot' instead of dealing with mergemaster, since my jails
to not really get customizations to things in /etc, but mergemaster should
work as well.  You'll need to pass the -D argument to mergemaster, and
possibly -m as well if the source tree in question is not in /usr/src/.
Be sure to set DESTDIR for delete-old and delete-old-libs!

-Ben

> [1] https://www.freebsd.org/doc/handbook/jails-application.html
> [2] https://www.freebsd.org/doc/handbook/makeworld.html
___
freebsd-doc@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: 3.6. Disk Organization in FreeBSD Handbook

[Benjamin Kaduk]

Hi Ryan,

On Tue, 13 Oct 2015, Ryan England wrote:

> I noticed when reading through the handbook that there are broken images in
> the page titled "3.6 Disk Organization."  I've included a link below for your
> convenience.
> https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/disk-organization.html
>
> Is there anything I can do to assist in rectifying this issue?  I'd be happy
> to assist in any way possible.

Thanks for pointing this out.  It looks like r47275
(https://svnweb.freebsd.org/doc?view=revision=47275) was slightly
overzealous in disconnecting image files from the build, so the needed eps
files were not being generated during the website build.

The other removed images from that commit seem to all be screenshots, so I
am going to assume that they are actually no longer referenced without
checking.

I'm running a test build now to confirm that my fix works, and will commit
when it succeeds.

As Fehmi notes, please do feel free to open bug reports if you see other
issues; that helps us keep track of things that do not get addressed right
away.

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

Re: Updating the VMware Fusion section

[Benjamin Kaduk]

On Mon, 21 Sep 2015, Douglas Carmichael wrote:

> To whom it may concern:
>
> I was looking at the VMware Fusion part of the FreeBSD handbook 
> (http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/virtualization-guest-vmware.html)
>  and the screen shots come from an old version of Fusion.
>
> Who should I contact about updating the screenshots? (I have Fusion 8 myself.)

This list is a reasonable place, but an entry in bugzilla would be
slightly better, since you could attach the images to the ticket instead
of just including links to them in an email.

Please ensure that they are of the same format and resolution as the
existing images, and state that they are available under an appropriate
license (i.e., BSD 2-clause).

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

Re: FSTYP(8) Man Page

[Benjamin Kaduk]

On Thu, 3 Sep 2015, TD RSS wrote:

> Regarding FSTYP(8)Man Page 
> (http://www.freebsd.org/cgi/man.cgi?query=fstyp=8)
>
> The HISTORY section states:
> The fstyp command appearedin FreeBSD 11.0.
>  As of this date (3 Sep 2015), I don't believe FreeBSD 11.0 has been
> released. Should this state FreeBSD 10.0?

fstyp(8) was not present in FreeBSD 10.0, though it does appear to be
present in 10.2, which is released.  It seems that trasz@ has adjusted the
manual page in HEAD some six weeks ago to reflect that fact, though for
some reason even at
https://www.freebsd.org/cgi/man.cgi?query=fstyp=0=8=FreeBSD+11-current=default=html
(the FreeBSD 11-current suite of manual pages) the website does not seem
to reflect that.  The default release for manual pages on the web is the
newest current release, at present 10.2, which has the incorrect statement
in the manual page and cannot be changed.

Thanks for pointing this out, but the only thing there seems to be left to
do is investigate why the online manual pages for 11-current do not have
the updated version, since the commit itself has been merged back to
stable/10 .

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

Re: freebsd documentation help

[Benjamin Kaduk]

On Thu, 3 Sep 2015, Julian H. Stacey wrote:

> it'd be clunky, & freebsd.org doc project till now uses non HTML
> master format & doc tools (that never build for me), but consider:

cherry-picking, but feel free to start a new thread for that if you want
to dig into why they are not building for you.  (I can understand if you
aren't interested right now.)

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

Re: mention authenticated SMTP from ports in Sec 28.9

[Benjamin Kaduk]

On Thu, 30 Jul 2015, Anton Shterenlikht wrote:

 I've been using smtp auth, as per handbook
 http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/SMTP-Auth.html
 for years.

 Lately I'm trying to move to binary updates on amd64,
 which means not rebuilding parts of the world by hand.

 So I installed mail/sendmail package which is
 built with authentication support (sendmail+tls+sasl2-8.15.1).
 I followed the config instructions at the end of the install
 message and things seem to work fine.

 I think it's worth mentioning, at the very beginning of
 http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/SMTP-Auth.html
 that using sendmail from ports is a convenient alternative to
 these instructions.

That's probably a good idea.  It seems likely that there was not a
sendmail port that defaulted to having authentication support at the time
this section was written, not to mention being present in a usable package
system.

 Are there any downsides to using sendmail from ports
 vs the OS sendmail?

I think the only issues are generic ones to having a software installed in
both the base system and from ports, involving making sure everything is
using the version from ports, and what happens during early startup before
/usr/local is ready.  I don't expect it to be particularly onerous for the
case of sendmail.

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

Re: Improvement to pthread_getspecific(3)

[Benjamin Kaduk]

On Mon, 18 May 2015, Patrick Kelsey wrote:

 Hi,

 I'd like to make the attached improvement to pthread_getspecific(3), and
 this is my first time through a man page edit/commit, so I have a couple of
 questions and would like to catch whatever else I'm missing.

 1. Attribution - I'm using a lightly edited line from
 http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_getspecific.html
 (edited to account for the fact that we do not document both
 pthread_getspecific() and pthread_setspecific() in the same man page).  I'm
 assuming that this falls under whatever agreement covers the existing man
 page (which was constructed in similar fashion), but there is currently no
 attribution in pthread_getspecific(3) and I'm not aware of what agreement
 may be in place that allows for this.

I'm not aware of what agreement may be in place, either.

In a somewhat related vein, I do note:
.Sh STANDARDS
The
.Fn pthread_getspecific
function conforms to
.St -p1003.1-96 .


 2. Markup - should I be using .Pq instead of explicit parentheses?

We do not have a strong preference for Pq over explicit parentheses, so I
would leave them in.

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

Re: Handbook x-config-quick-start is missing information to configure HAL and DBUS

[Benjamin Kaduk]

On Thu, 2 Apr 2015, Kaio Rafael wrote:

 Hello,

 I am following Chapter 6. The X Window System [1] to install Xorg into my box.

 I have installed the xorg package with pkg install xorg as the
 handbook explains, but HAL service procedure is giving error:

 '
 service hald start
 hald does not exist in /etc/rc.d or the local startup
 directories (/usr/local/etc/rc.d)
 '

 I believe you should add a note for those users that install binary
 xorg (using pkg) should also add 'HAL' using 'pkg'

I believe that HAL is no longer strictly needed for a functional X
desktop, these days, so a different edit to the handbook may be more
appropriate.

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

Re: no poudriere(8) man page online

[Benjamin Kaduk]

On Mon, 23 Feb 2015, Anton Shterenlikht wrote:

 http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-poudriere.html

 The very last line gives a link to poudriere(8) man
 page only, which does not exist.

Try
https://www.freebsd.org/cgi/man.cgi?query=poudriereapropos=0sektion=0manpath=FreeBSD+10.1-RELEASE+and+Portsarch=defaultformat=html

 for immediate use.  I'm not sure why the XML entity is not expanding to
the correct URL, offhand.

-Ben Kaduk
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to freebsd-doc-unsubscr...@freebsd.org

Re: [FAQ] Wrong size of supported maximum RAM

[Benjamin Kaduk]

On Wed, 21 Jan 2015, Torsten Zuehlsdorff wrote:

 Hello,

 the FAQ says in chapter 4.1.2:
 AMD64 platforms currently deployed support up to 1 TB of physical memory.

 This is currently no longer true since 10.0. There it was raised to 4 TB. Have
 a look at:
 https://www.freebsd.org/releases/10.0R/relnotes.html

 Chapter 2.2, fourth paragraph. Can somebody update this?

Unfortunately, the release notes are immutable after the release.

The statement in question does not appear to be present in the 10.1
release notes, so it is possible that no action is needed.

-Ben Kaduk
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to freebsd-doc-unsubscr...@freebsd.org

Re: Getting an Event Posted on www.freebsd.org

[Benjamin Kaduk]

On Thu, 11 Dec 2014, Kirk McKusick wrote:

 I am getting ready to teach my FreeBSD Class in Berkeley and would
 like to get a link to it noted in the upcoming events section of
 the www.freebsd.org web page. Who is the person to whom I should
 send my request?

Sending the details to this list or filing a documentation issue in
bugzilla should be fine.

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

RE: Wiki - Unable to create an account

[Benjamin Kaduk]

On Wed, 3 Dec 2014, Ricardo Santos wrote:

  Subject: Re: Wiki - Unable to create an account
  From: li...@isogram.nl
  Date: Wed, 3 Dec 2014 13:39:39 +0100
  CC: freebsd-doc@freebsd.org
  To: r.san...@live.co.uk
 
  Hi,
 
   In order to share my experience with 11.0-CURRENT on my laptop, I would 
   like to create an account at the wiki but I'm getting this error: 
   'unknown action newaccount'.
  
   Is this an issue or the registrations have been disabled?

Registrations have been disabled, and the last I checked, clusteradm will
only create wiki accounts upon request of a FreeBSD committer.  The spam
problem was just too big.

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

Re: HOWTO articles for migrating from Linux to FreeBSD, especially for pkg?

[Benjamin Kaduk]

On Thu, 23 Oct 2014, Mason Loring Bliss wrote:

 On Thu, Oct 23, 2014 at 10:20:20AM +0200, Lars Engels wrote:

  Please register with your realname and I can give you the needed rights.

 A snag...

 When I click 'Logic' at the top of the page it brings me to the login form,
 which has a link to

 https://wiki.freebsd.org/action/newaccount/FrontPage?action=newaccount

 However, this produces a red error icon and the message Unknown action
 newaccount.

 I'll be happy to sign up once this is resolved, one way or the other.

If I remember correctly, a committer needs to request the wiki account
creation for a given user name and associated email address.

I think you should send those (offlist) to Lars or me, and we can make the
actual request.

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

Re: libthr and main thread stack size

[Benjamin Kaduk]

On Sat, 20 Sep 2014, Konstantin Belousov wrote:

 Doc people, please review the man page in the patch.

BTW, mandoc -Tlint is always a useful sanity check; it found:
./libthr.7:31:5: WARNING: document title should be all caps
./libthr.7:36:2: WARNING: section header suited to sections 2, 3, and 9 only: 
LIBRARY
./libthr.7:194:2: WARNING: skipping paragraph macro

I am not sure what the best solution is the section header complaint.
The current libthr.3 is quite short; maybe the two could be merged?


I made some changes in the attached diff, though I am not fully happy with
the final result.  In particular, I am not sure that my text in the
section THREAD STACKS is correct.

I also changed from the .Dv macro for library names like libc, to the .Li
macro, which is sort of a catch-all option; there may be something better.

-Ben--- libthr.7.orig   2014-09-21 16:19:24.719162740 -0400
+++ libthr.72014-09-21 18:10:05.289706149 -0400
@@ -28,7 +28,7 @@
 .\ $FreeBSD$
 .\
 .Dd September 20, 2014
-.Dt libthr
+.Dt LIBTHR
 .Os
 .Sh NAME
 .Nm libthr
@@ -38,129 +38,124 @@
 .Sh DESCRIPTION
 The man page documents the quirks and tunables of the
 .Fx
-implementation for the
+implementation of the
 .Lb libpthread .
-When linking with the
+When linking with
 .Li -lpthread ,
 the run-time dependency
-.Dv libthr.so.3
-library is recorded in the produced object.
+.Li libthr.so.3
+is recorded in the produced object.
 .Pp
-The library is tigthly integrated with the Run-time Link-editor
+The library is tightly integrated with the run-time link editor
 .Xr ld-elf.so.1 1
 and
-.Lb libc ,
+.Lb libc ;
 all three components must be built from the same source tree.
 Mixing
-.Dv libc.so
+.Li libc.so
 and
 .Nm
 libraries from different versions of
 .Fx
 is not supported.
 The run-time linker
-.Li ld-elf.so.1
-has some code to ensure backward-compatibility with older
+.Xr ld-elf.so.1 1
+has some code to ensure backward-compatibility with older versions of
 .Nm .
 .Sh MUTEX ACQUISITION
-The locked mutex (see
+A locked mutex (see
 .Xr pthread_mutex_lock 3 )
 is represented by a volatile variable of type
 .Dv lwpid_t ,
 which records the global system identifier of the thread
 owning the lock.
-The
 .Nm
-performs a congested mutex acquisition in three stages, each of which
+performs a contested mutex acquisition in three stages, each of which
 is more resource-consuming than the previous.
 .Pp
-First, the
-.Li spin loop
+First, a spin loop
 is performed, where the library attempts to acquire the lock by
 .Xr atomic 9
 operations.
 The loop count is controlled by the
 .Ev LIBPTHREAD_SPINLOOPS
-environment variable.
+environment variable, with a default value of 2000.
 .Pp
-If the
-.Li spin loop
-was unable to acquire the mutex, the
-.Li yield loop
+If the spin loop
+was unable to acquire the mutex, a yeild loop
 is executed, performing the same
 .Xr atomic 9
-acquisition attempts as
-.Li spin loop ,
-but each attempt is followed by yield of the CPU time of the thread by
+acquisition attempts as the spin loop,
+but each attempt is followed by a yield of the CPU time
+of the thread using the
 .Xr sched_yield 2
 syscall.
-By default, the
-.Li yield loop
+By default, the yield loop
 is not executed.
-This is controlled by
+This is controlled by the
 .Ev LIBPTHREAD_YIELDLOOPS
 environment variable.
 .Pp
-If both
-.Li spin
-and
-.Li yield loops
+If both the spin and yield loops
 failed to acquire the lock, the thread is taken off the CPU and
-put to sleep in kernel with the
+put to sleep in the kernel with the
 .Xr umtx 2
 syscall.
-Kernel wakes up a thread and hands the ownership of the lock to
-the woken thread.
-.Sh THREADS STACKS
-Each thread is provided with the private stack area used by C runtime.
-The size of the main (initial) thread stack is set by kernel, and is
+The kernel wakes up a thread and hands the ownership of the lock to
+the woken thread when the lock becomes available.
+.Sh THREAD STACKS
+Each thread is provided with a private stack area used by the C runtime.
+The size of the main (initial) thread stack is set by the kernel, and is
 controlled by the
 .Dv RLIMIT_STACK
 process resource limit (see
 .Xr getrlimit 2 ) .
 .Pp
-By default, the main thread size is equal to the value of resource
+By default, the main thread's stack size is equal to the value of
 .Dv RLIMIT_STACK
 for the process.
 If the
-.Dv LIBPTHREAD_SPLITSTACK_MAIN
-environment variable is present (its value does not matter),
-the main thread size if chomped to 4MB on 64bit architectures, and to
-2MB on 32bit architectures, on the threading library initialization.
-The rest of the address space area reserved by the kernel for initial
-process stack, is used for non-initial threads stack in this case.
+.Ev LIBPTHREAD_SPLITSTACK_MAIN
+environment variable is present in the process environment
+(its value does not matter),
+the main thread's stack is reduced to 4MB on 64bit architectures, and to
+2MB on 32bit architectures, when the threading library is 

Re: /etc/motd update

[Benjamin Kaduk]

On Fri, 5 Sep 2014, Warren Block wrote:

 Agreed.  Updated, shorter version:

 http://www.wonkity.com/~wblock/motd/motd
 http://www.wonkity.com/~wblock/motd/motd.diff


% o  Documents installed with the system are in /usr/local/share/doc/freebsd.

That line is only 75 characters, so I would strongly recommend to use a
trailing slash on the 'freebsd' directory, which would eliminate potential
problems from copying the full stop at the end of the sentence.

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

Re: /etc/motd update

[Benjamin Kaduk]

On Wed, 13 Aug 2014, Warren Block wrote:

 The existing /etc/motd breaks many of our document rules and has some weird
 language constructs.  The current version in HEAD:
 http://svnweb.freebsd.org/base/head/etc/motd?view=co

 Here is a rewrite.  URLs are now the only thing on a line, instead of inline
 and hard to locate.  No contractions are used.  Odd phrases are rephrased:

 Here is the proposed new version and a diff:
 http://www.wonkity.com/~wblock/motd/motd
 http://www.wonkity.com/~wblock/motd/motd.diff

I think that Before seeking technical support, please use these
resources remains an awkward phrase.  The intent is to have the user
attempt to help themself before resorting to flailing and asking for help
on the internet, but not all of the listed resources are relevant for any
particular situation, and in some sense they *are* providing technical
support.

We may just want to note that The following resources are available to
learn about the system, or something of a similar phrasing.

The other changes seem okay.

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

Re: HOWTO articles for migrating from Linux to FreeBSD, especially for pkg?

[Benjamin Kaduk]

On Fri, 18 Jul 2014, Matthew Seaman wrote:


On 07/18/14 15:14, Allan Jude wrote:

So you mean like, a phpmyadmin-apache-config metapackage, that depends
on apache and phpmyadmin, but installs an enabled, working config?


Exactly.


Here at MIT, our Athena systems have something like 40 different config 
packages to customize the configuration of our (Debian/Ubuntu-based) 
systems.  Our Debathena project makes such heavy use of configuration 
packages that very early on, we wrote some infrastructure to make it 
easier to create and manage them: 
http://debathena.mit.edu/config-packages/


I would love to see a similar toolkit for FreeBSD.

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

Re: Booting FreeBSD from an LVM volume

[Benjamin Kaduk]

Hi David,

On Fri, 11 Jul 2014, David Newall wrote:


I've written a brief article explaining how to boot FreeBSD from a LVM2
volume.  Extensive search of the web suggested it could not be done, but
it can, and easily.  I thought this might be of interest to the
community, and perhaps even suitable for inclusion on the FreeBSD web or
handbook.  See http://davidnewall.com/papers/Boot-FreeBSD-on-LVM2.html.


Thanks for the pointer to this article -- it's quite an interesting tale.

The article itself is written in a style that one might find on a blog, 
which is not really a suitable style for direct inclusion into the FreeBSD 
handbook.  However, I think this would be a helpful example to have, and I 
will look into the possibility of adding it.  (But probably not for a 
month or so, I've got a lot on my plate at the moment.)


Thanks for the writeup and pointing us to it!

-Ben Kaduk
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to freebsd-doc-unsubscr...@freebsd.org

Re: docs/188214: Manpage for fsck(8) doesn#39;t say what happens when no -t or -T

[Benjamin Kaduk]

The following reply was made to PR docs/188214; it has been noted by GNATS.

From: Benjamin Kaduk b...@freebsd.org
To: Tom Rhodes trho...@freebsd.org
Cc: Allan Jude allanj...@freebsd.org, bug-follo...@freebsd.org
Subject: Re: docs/188214: Manpage for fsck(8) doesn#39;t say what happens
 when no -t or -T
Date: Sat, 24 May 2014 17:42:47 -0400 (EDT)

 On Sat, 24 May 2014, Tom Rhodes wrote:
 
  So, in theory, an attempt to parse /etc/fstab would be
  an attempt to detect the type; however, my quick glance
  at the code showed no real parsing of fstab.  But in
  my case, I followed to both the T and t flags, and just
  glanced at what was done would they not be specified.
  That was really as far as I got, and I attempted to use
  very generic language in case it only does one, or the
  other, or both.  :)
 
 When passed no device or path arguments, fsck just checks everything from 
 the fstab; that's not very interesting for this question.
 
 Given a path argument and no type argument to use, fstab is parsed using 
 getfsfile() or getfsspec() around line 204 of fsck.c.  This will fail 
 (well, barring special circumstances) if the argument is instead a device 
 name.
 
 Given a device name argument and no type argument to use, after the fstab 
 check above, fsck opens the device and uses ioctl() to get the disklabel 
 and does some magic to grab the fstype from it.  (See getfslab(), in 
 fsck.c)
 
 
 So, I think there is a fair bit of autodetection that is attempted.
 
 -Ben
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to freebsd-doc-unsubscr...@freebsd.org

Re: request: help updating TASKQUEUE(9)

[Benjamin Kaduk]

On Sat, 24 May 2014, Adrian Chadd wrote:


Hi,

I've just added a new call to taskqueue -
taskqueue_start_threads_pinned(). It's like taskqueue_start_threads(),
but it takes a cpuid to pin the threads to.

Would someone please help me with the manpage markup and wording?


Something like this?

-BenIndex: share/man/man9/taskqueue.9
===
--- share/man/man9/taskqueue.9  (revision 266330)
+++ share/man/man9/taskqueue.9  (working copy)
@@ -28,7 +28,7 @@
 .\
 .\ $FreeBSD$
 .\
-.Dd January 24, 2014
+.Dd May 24, 2014
 .Dt TASKQUEUE 9
 .Os
 .Sh NAME
@@ -68,6 +68,11 @@
 .Fn taskqueue_create_fast const char *name int mflags 
taskqueue_enqueue_fn enqueue void *context
 .Ft int
 .Fn taskqueue_start_threads struct taskqueue **tqp int count int pri 
const char *name ...
+.Ft int
+.Fo taskqueue_start_threads_pinned
+.Fa struct taskqueue **tqp int count int pri int cpu_id
+.Fa const char *name ...
+.Fc
 .Ft void
 .Fn taskqueue_set_callback struct taskqueue *queue enum 
taskqueue_callback_type cb_type taskqueue_callback_fn callback void 
*context
 .Ft void
@@ -145,7 +150,14 @@
 which the thread servicing the queue will be signaled that it should exit.
 .Pp
 Once a taskqueue has been created, its threads should be started using
-.Fn taskqueue_start_threads .
+.Fn taskqueue_start_threads
+or
+.Fn taskqueue_start_threads_pinned .
+.Fn taskqueue_start_threads_pinned
+takes a
+.Va cpu_id
+argument which will cause the threads which are started for the taskqueue
+to be pinned to run on the given CPU.
 Callbacks may optionally be registered using
 .Fn taskqueue_set_callback .
 Currently, callbacks may be registered for the following purposes:
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to freebsd-doc-unsubscr...@freebsd.org

Re: hier(7) mentions tests(7) which does not exist

[Benjamin Kaduk]

On Thu, 8 May 2014, Anton Shterenlikht wrote:


hier(7) has

   tests/The FreeBSD test suite.  See tests(7) for more
 details.

HOwever tests(7) man page doesn't seem to exist.
Should hier man page be updated?
Is /usr/tests still being used for the test suite?


WITH_TESTS must be set in src.conf for the tests to be built and 
installed.  The manual page tests.7 will also be installed in that case.


-Ben Kaduk
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to freebsd-doc-unsubscr...@freebsd.org

Re: hier(7) mentions tests(7) which does not exist

[Benjamin Kaduk]

On Thu, 8 May 2014, Allan Jude wrote:


On 2014-05-08 19:23, Benjamin Kaduk wrote:

On Thu, 8 May 2014, Anton Shterenlikht wrote:


hier(7) has

   tests/The FreeBSD test suite.  See tests(7) for more
 details.

HOwever tests(7) man page doesn't seem to exist.
Should hier man page be updated?
Is /usr/tests still being used for the test suite?


WITH_TESTS must be set in src.conf for the tests to be built and
installed.  The manual page tests.7 will also be installed in that case.


Maybe the tests man page should be installed regardless, with a note
about what is required to be able to use the tests (the src.conf flag)


Hmm, r264410 seems to claim to do this on head already.  I guess the 
checkout I was looking at was a bit stale.


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

em dashes in mdoc (was Re: Hello fdclose)

[Benjamin Kaduk]

[changing cc list dramatically]

On Wed, 19 Mar 2014, Bruce Evans wrote:


On Tue, 18 Mar 2014, John Baldwin wrote:


@@ -84,7 +130,9 @@
.Sh NOTES
The
.Fn fclose
-function
+and
+.Fn fdclose
+functions
does not handle NULL arguments; they will result in a segmentation
violation.
This is intentional - it makes it easier to make sure programs written



In the old version:

Em-dash seems to be handled poorly by mdoc.  It seems to be necessary
to hard code it.  It shouldn't be hard coded as a hyphen.


I seem to remember looking into mdoc's handling of em dashes a month or 
two ago, and concluding that mdoc did not handle em dashes at all.  That 
is, I did not see any macros that attempted to render as a dash of any 
type, so that the man page author is required to hard code a dash as 
either one or two (or three, I suppose) hyphens.


A scan of the prior art suggested that most existing instances use a 
single hyphen, and the double hyphen is quite rare.


Warren did note that it is probably best to write in a style that avoids 
the need for the em dash, which I cannot really argue against.


Bruce, do you have any details you can add about mdoc's interaction with 
em (or en) dashes?


Thanks,

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

Re: docs/186608: typo in 'ctime(3) man page

[Benjamin Kaduk]

On Sun, 9 Feb 2014, Jamie Landeg-Jones wrote:




Description:


Another typo. This time in ctime.3 man page..  I realise this is in 
'contrib' but there doesn't seem to be any info regarding who this is 
pulled from.


I think that the current ~upstream for the tzcode is supposed to be 
https://github.com/eggert/tz/ , but I haven't checked particularly 
recently.  (There was some excitement involving a legal action, etc., so 
it had gone away and/or moved.)  That said, I don't see a BUGS section at 
all in the newctime.3 in that repo, and I also don't see the erroneous 
line you quote in the history of that repo, so ... I'm not sure what 
happened.



I hope I don't get the reputation for most anal contributor :-(


Definitely not!

(Is a PR the best way to report something so insignificant? Seems like 
overkill... Gimme doc commit access!)


PR is fine, it gives us a place to look when we need to find things.


Anyway The word 'leaves' instead of 'leave' in the following line:

-these functions leaves their result in an internal static object and return


Thanks for pointing it out.  I'll try to think about what the best route 
to a fix is.


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

Re: docs/186608: typo in 'ctime(3) man page

[Benjamin Kaduk]

The following reply was made to PR docs/186608; it has been noted by GNATS.

From: Benjamin Kaduk b...@freebsd.org
To: Jamie Landeg-Jones ja...@dyslexicfish.net
Cc: freebsd-gnats-sub...@freebsd.org, freebsd-doc@freebsd.org
Subject: Re: docs/186608: typo in 'ctime(3) man page
Date: Mon, 10 Feb 2014 14:54:16 -0500 (EST)

 On Sun, 9 Feb 2014, Jamie Landeg-Jones wrote:
 
 
  Description:
 
  Another typo. This time in ctime.3 man page..  I realise this is in 
  'contrib' but there doesn't seem to be any info regarding who this is 
  pulled from.
 
 I think that the current ~upstream for the tzcode is supposed to be 
 https://github.com/eggert/tz/ , but I haven't checked particularly 
 recently.  (There was some excitement involving a legal action, etc., so 
 it had gone away and/or moved.)  That said, I don't see a BUGS section at 
 all in the newctime.3 in that repo, and I also don't see the erroneous 
 line you quote in the history of that repo, so ... I'm not sure what 
 happened.
 
  I hope I don't get the reputation for most anal contributor :-(
 
 Definitely not!
 
  (Is a PR the best way to report something so insignificant? Seems like 
  overkill... Gimme doc commit access!)
 
 PR is fine, it gives us a place to look when we need to find things.
 
  Anyway The word 'leaves' instead of 'leave' in the following line:
 
  -these functions leaves their result in an internal static object and 
  return
 
 Thanks for pointing it out.  I'll try to think about what the best route 
 to a fix is.
 
 -Ben
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to freebsd-doc-unsubscr...@freebsd.org

Re: Fwd: Re: svn commit: r258713 - in head/sys: kern sys

[Benjamin Kaduk]

On Fri, 24 Jan 2014, Andriy Gapon wrote:



I would like to commit the following manual page update.
Could you please review it?
Thank you very much!

 Original Message 
Message-ID: 52d93f91@freebsd.org
Date: Fri, 17 Jan 2014 16:34:57 +0200
From: Andriy Gapon a...@freebsd.org
To: Justin T. Gibbs gi...@scsiguy.com
CC: src-committ...@freebsd.org, svn-src-...@freebsd.org,  
svn-src-h...@freebsd.org
Subject: Re: svn commit: r258713 - in head/sys: kern sys
References: 201311281856.rasiuzu8059...@svn.freebsd.org
3784c560-3648-4e03-93da-9a60e3ac4...@scsiguy.com
In-Reply-To: 3784c560-3648-4e03-93da-9a60e3ac4...@scsiguy.com

on 30/11/2013 08:46 Justin T. Gibbs said the following:

Man page update?


I came up with the following update that
- adds taskqueue_drain_all documentation
- extends taskqueue_drain description
- adds description for previously undocumented taskqueue_block /
taskqueue_unblock, including a warning on taskqueue_block + taskqueue_drain
combination

All reviews and suggestions are welcome.  Both for content and language.

diff --git a/share/man/man9/taskqueue.9 b/share/man/man9/taskqueue.9
index 5f6131a..4db3d7a 100644
--- a/share/man/man9/taskqueue.9
+++ b/share/man/man9/taskqueue.9
@@ -86,6 +86,12 @@ struct timeout_task;
.Fn taskqueue_drain struct taskqueue *queue struct task *task
.Ft void
.Fn taskqueue_drain_timeout struct taskqueue *queue struct timeout_task
*timeout_task
+.Ft void
+.Fn taskqueue_drain_all struct taskqueue *queue
+.Ft void
+.Fn taskqueue_block struct taskqueue *queue
+.Ft void
+.Fn taskqueue_unblock struct taskqueue *queue
.Ft int
.Fn taskqueue_member struct taskqueue *queue struct thread *td
.Ft void
@@ -255,6 +261,74 @@ function is used to wait for the scheduled task to finish.
There is no guarantee that the task will not be
enqueued after call to
.Fn taskqueue_drain .
+Because the caller typically would use
+.Fn taskqueue_drain
+to put the task into a known state, then the caller should use


This then is a bit odd, I think the sentence is better without it.


+out-of-band means to ensure, before calling
+.Fn taskqueue_drain ,
+that the task would not be enqueued.
+For example, if the task is enqueued by an interrupt filter, then
+the interrupt could be disabled.
+.Pp
+The
+.Fn taskqueue_drain_all
+function is used to wait for all the pending and running tasks that
+are enqueued on the taskqueue to finish.
+The caller must arrange that the tasks are not re-enqueued.
+Note that
+.Fn taskqueue_drain_all
+currently does not handle tasks with delayed enqueueing.
+.Pp
+The
+.Fn taskqueue_block
+function blocks the taskqueue.
+It prevents any enqueued but not running tasks from being executed.
+Future calls to
+.Fn taskqueue_enqueue
+will enqueue tasks, but the tasks will not be run until
+.Fn taskqueue_unblock
+is called.
+Please note that
+.Fn taskqueue_block
+does not wait for any currently running tasks to finish.
+Thus, the
+.Fn taskqueue_block
+does not provide a guarantee that
+.Fn taskqueue_run
+is not running after
+.Fn taskqueue_block
+returns, but it does provide a guarantee that
+.Fn taskqueue_run
+will not be called again
+until
+.Fn taskqueue_unblock
+is called.
+If the caller requires a guarantee that
+.Fn taskqueue_run
+is not running, then this must be arranged by the caller.
+Note that if
+.Fn taskqueue_drain
+is called on a task that is enqueued on a taskqueue that is blocked by
+.Fn taskqueue_block ,
+then
+.Fn taskqueue_drain
+can not return until the taskqueue is unblocked.


I would prefer cannot as a single word here, though I don't think our 
style guide says anything about this case.



+This can result in a deadlock if the thread blocked in
+.Fn taskqueue_drain
+is a thread that is supposed to call


Is s/a/the/ correct?  That is, by my reading, if the thread blocked in 
taskqueue_drain is only one of several that could call taskqueue_unblock, 
the other threads would still (eventually) do so and there is no deadlock. 
So the risk of deadlock would (only?) be if there is only one thread that 
is supposed to call taskqueue_unblock.



+.Fn taskqueue_unblock .
+Thus, use of
+.Fn taskqueue_drain
+after
+.Fn taskqueue_block
+is discouraged, because a state of the task can not be known in advance.


s/ a / the / here is needed, though, I am certain.


+The same applies to


I would put another noun here, as same caveat or same warning or 
something like that.


-Ben


+.Fn taskqueue_drain_all .
+.Pp
+The
+.Fn taskqueue_unblock
+function unblocks the previously blocked taskqueue.
+All enqueued tasks can be run after this call.
.Pp
The
.Fn taskqueue_member


--
Andriy Gapon


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


___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, 

Re: Web site build issue: ports/categories

[Benjamin Kaduk]

On Tue, 14 Jan 2014, Václav Zeman wrote:


On 01/13/2014 09:52 PM, Benjamin Kaduk wrote:


I don't see a 'mate' category in the ports svn repo.

Are you perhaps using a patched ports tree on the machine in question,
with a custom INDEX corresponding to it?

-Ben Kaduk

Nothing hacked here. The category seems to be in the INDEX file, see
below. This has caused the portindex script to generate wrong XHTML
which resulted into build breakage due to failing XML validity check.


mate-media-1.6.0|/usr/ports/audio/mate-media|/usr/local|Multimedia
applications for the MATE


I would suggest that you move your INDEX out of the way and fetch a new 
one, it seems likely that this is just a corrupt INDEX.
(We had a corrupt INDEX on one of the machines that builds the website a 
while back, that was annoying to debug.)


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

Re: Web site build issue: ports/categories

[Benjamin Kaduk]

On Tue, 14 Jan 2014, Václav Zeman wrote:


I am using portsnap to fetch the Ports. Why would it be corrupt? The
mate category is there.


My apologies, your initial diagnosis seems correct.

I am confused why we are not seeing automated build failure mail, though; 
I thought only some of the automatic build email was directed away from 
the list.


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

Re: Typo in Example 19.1 in Handbook?

[Benjamin Kaduk]

On Mon, 16 Dec 2013, Mike. wrote:




This example

http://www.freebsd.org/doc/handbook/geom-glabel.html#idp80661168


has the text

...Reboot the system, and at the loader(8) prompt, press 4 to
boot into single user mode. Then enter the following
commands:...


I run FreeBSD 9.2, and the 'boot into single user mode' option
shows as #2 on the loader menu. Option #4 is 'Reboot'.

Did the option numbering change since the example was written?
If the option numbering does chnage between releases, maybe the
mention of the option number should be removed and the option
text used instead.


The numbering did change since that example was written, though I believe 
there is strong pressure to not repeat such a change.  (The numbering 
change was part of a big rewrite in how the loader interface presented 
itself.)


I will try to update the text to be correct for the current numbering 
scheme.


Thanks for the report!

-Ben Kaduk
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to freebsd-doc-unsubscr...@freebsd.org

Re: FreeBSD web build failed on oldred.freebsd.org

[Benjamin Kaduk]

On Fri, 18 Oct 2013, Glen Barber wrote:


On Fri, Oct 18, 2013 at 11:41:27PM -0400, Benjamin Kaduk wrote:

This seems to be generated content, so I would be
somewhat inclined to blame a broken INDEX file for whichever build
this is, which does not necessarily have to correspond to a
particular commit.


I do not know what you mean whichever build this is.

INDEX is INDEX.  It is either broken, or not.  AFAIK, it is not.


I should have said corrupt, not broken.

I just now noticed that in the INDEX-9.bz2 I grabbed last night from 
http://www.freebsd.org/ports/INDEX-9.bz2, there does appear to be an entry 
for clang/usr/local/llvm32-3.2, which matches the entry that xmllint was 
complaining about.  No other entries in that INDEX-9 have a '/' prior to 
the first '|' separator character.


Downloading a fresh copy of INDEX-9.bz2 (sha256 
4e6a949d95777345fd0a453a1139a20021a7fa549771ca62c390d0b847987700) from 
that same URL, the expanded file does not contain a malformed name entry 
for (any version of) clang.


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

Re: FreeBSD web build failed on oldred.freebsd.org

[Benjamin Kaduk]

Probably that there is no content between the opening and closing anchor 
tags?

ISTR a similar issue for pipermail coming up  on IRC recently.

-Ben

On Fri, 18 Oct 2013, Glen Barber wrote:


I've stopped the builds on oldred for now, until I figure out what is
misfiring here.

Glen

On Sat, Oct 19, 2013 at 02:50:35AM +, World Wide Web Owner wrote:

=== support
=== cgi
=== cgi/GnatsPR
=== cgi/GnatsPR/Section
=== gifs
=== layout
=== layout/css
=== layout/images
=== layout/js
=== logo
=== ../../da_DK.ISO8859-1/htdocs
=== ../../de_DE.ISO8859-1/htdocs
=== ../../de_DE.ISO8859-1/htdocs/community
=== ../../de_DE.ISO8859-1/htdocs/developers
=== ../../de_DE.ISO8859-1/htdocs/docproj
=== ../../de_DE.ISO8859-1/htdocs/docs
=== ../../de_DE.ISO8859-1/htdocs/news
=== ../../de_DE.ISO8859-1/htdocs/news/2009
=== ../../de_DE.ISO8859-1/htdocs/news/2008
=== ../../de_DE.ISO8859-1/htdocs/news/2007
=== ../../de_DE.ISO8859-1/htdocs/news/2006
=== ../../de_DE.ISO8859-1/htdocs/news/2005
=== ../../de_DE.ISO8859-1/htdocs/news/2004
=== ../../de_DE.ISO8859-1/htdocs/news/2003
=== ../../de_DE.ISO8859-1/htdocs/news/2002
=== ../../de_DE.ISO8859-1/htdocs/FAQ
=== ../../de_DE.ISO8859-1/htdocs/handbook
=== ../../de_DE.ISO8859-1/htdocs/ipv6
=== ../../de_DE.ISO8859-1/htdocs/java
=== ../../de_DE.ISO8859-1/htdocs/platforms
=== ../../de_DE.ISO8859-1/htdocs/platforms/ia64
=== ../../de_DE.ISO8859-1/htdocs/ports
cd /w/www/build/head/de_DE.ISO8859-1/htdocs/ports;  make  
DIRPRFX=../../de_DE.ISO8859-1/htdocs/ -f 
/w/www/build/head/de_DE.ISO8859-1/htdocs/ports/Makefile.inc0 all
env 
XML_CATALOG_FILES=file:///w/www/build/head/de_DE.ISO8859-1/htdocs/ports/catalog-cwd.xml
  file:///w/www/build/head/de_DE.ISO8859-1/share/xml/catalog.xml  
file:///w/www/build/head/share/xml/catalog.xml  
file:///w/www/build/head/share/xml/catalog-common.xml  
file:///usr/local/share/xml/catalog /usr/local/bin/xmllint  --xinclude --valid 
--noout --nonet devel.xml
devel.xml:291: element a: validity error : Syntax of value for attribute name 
of a is not valid
dtba name=clang/usr/local/llvm32-3.2/aa href=http://www.FreeBSD.org/
   ^
*** Error code 4

Stop in /w/www/build/head/de_DE.ISO8859-1/htdocs/ports.
*** Error code 1

Stop in /w/www/build/head/de_DE.ISO8859-1/htdocs/ports.
*** Error code 1

Stop in /w/www/build/head/de_DE.ISO8859-1/htdocs.
*** Error code 1

Stop in /w/www/build/head/en_US.ISO8859-1/htdocs.
3.83 real 2.25 user 1.56 sys
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to freebsd-doc-unsubscr...@freebsd.org



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

Re: Fwd: Re: FreeBSD 10 and zfsd

[Benjamin Kaduk]

Note that '.Xr zfsd 8' is incorrect usage until zfsd is actually imported.
-Ben

On Thu, 10 Oct 2013, Allan Jude wrote:


 Original Message 
Subject:Re: FreeBSD 10 and zfsd
Date:   Thu, 10 Oct 2013 16:27:54 -0700
From:   Lyndon Nerenberg lyn...@orthanc.ca
To: Allan Jude free...@allanjude.com
CC: freebsd-curr...@freebsd.org



On 2013-10-10, at 2:54 PM, Allan Jude free...@allanjude.com wrote:


I've been working on the handbook section on ZFS and made certain to
mention that, I'll have to look at improving the man page as well, but
as far as I know, the man page is imported from IllumOS, where spares do
work.


This is probably worthy of an in-tree man page update.  FreeBSD has a 
reputation for having highly accurate man pages, therefore people tend to take 
what they read as gospel.  Right now zpool(8) clearly spells out that hot spare 
substitution works.  When 10.0 goes live, people are going to believe that, and 
unknowingly put themselves in a position where Bad Things could happen.  Until 
zfsd goes into the tree, zpool(8) should have a warning that the hot spare 
functionality is not available under FreeBSD.

Proposed diff attached.

--lyndon






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

Re: svn commit: r42201 - head/en_US.ISO8859-1/books/fdp-primer/docbook-markup

[Benjamin Kaduk]

[moving to the -doc list for discussion]

On Tue, 9 Jul 2013, Warren Block wrote:


On Tue, 9 Jul 2013, Gabor Kovesdan wrote:


Em 09-07-2013 21:13, Benjamin Kaduk escreveu:

 Remove a confusing paragraph whose net contribution is negative.  Remove
 some nbsp; from Ports Collection, it's unnecessary. Make one example


Was this discussed anywhere?  I am seeing a pretty long precedent for the 
non-breaking space. 
Indeed it wasn't discussed but I think that these non-breaking spaces 
should be reconsidered.


I had added the nbsp; to the Ports Collection in the word list very 
recently, then saw that it really made no sense to force those two words to 
be on the same line.


Typography rules and conventions are language-dependent. For example, in 
Hungarian it is not nice to end a line with a sentence-starting 
single-letter article. Afaik, English does not have such rules, except 
widows and orphans, which are more concerned with aesthetics. It is 
reasonable to avoid a line break between FreeBSD and 9.X or similar cases 
but probably not for such long terms as Ports Collection. Actually, it may 
just hit back because it may make justified paragraphs very ugly in our 
print formats.


Exactly.


I have done my share of fitting relatively large font text into a small 
space and trying to get the wrapping to look nice; with a nbsp there will 
almost certainly be some font size+page width combinations that look bad.


We should probably discuss and decide one way or the other and actually 
put it in the word list, so we remember for next time.  I actually don't 
have strong feelings either way.


I went back through the history of this file, and at least one instance 
was added in r33364 by pgj (cc'd), with review by gabor@, even!  That was 
back in Dec 2008, so changing our minds now would not be terrible, if we 
want to.


Does anyone want to argue for keeping the nbsp?

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

Re: svn commit: r42201 - head/en_US.ISO8859-1/books/fdp-primer/docbook-markup

[Benjamin Kaduk]

On Tue, 9 Jul 2013, Warren Block wrote:


On Tue, 9 Jul 2013, Benjamin Kaduk wrote:

I have done my share of fitting relatively large font text into a small 
space and trying to get the wrapping to look nice; with a nbsp there will 
almost certainly be some font size+page width combinations that look bad.


We should probably discuss and decide one way or the other and actually put 
it in the word list, so we remember for next time.  I actually don't have 
strong feelings either way.


Ports Collection is there now.  Or do you mean nbsp in general?  I think


No, I meant Ports Collection.

So, uh ... sorry for the noise.

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

Re: Misprint in Architecture Handbook?

[Benjamin Kaduk]

On Sun, 23 Jun 2013, Chip Senkbeil wrote:


Hello,

I was taking a look at the guide for SSDs and FreeBSD (
http://www.freebsd.org/doc/en/articles/solid-state/index.html) and think
that there might be some old instructions. On the second page (
http://www.freebsd.org/doc/en/articles/solid-state/kernel.html), the
instructions say to add options MFS, options MD_ROOT, and
pseudo-device md to your kernel configuration. I've been searching
briefly (very briefly) and came across a fairly old post (
http://lists.freebsd.org/pipermail/freebsd-stable/2005-May/015115.html)
claiming that pseudo-device is no longer used or is at least deprecated.
Trying to add that option gave me a syntax error; so, I'm going out on a
limb to say that the option isn't supported? I later found in the generic
kernel that the line device md is already in place with the comment
Pseudo devices.

Another issue (this may or may not be a fault of my own) is regarding
options MFS as a suggested addition to the configuration. Attempt to
include the option and build the kernel yields an unknown option error.
I'll be digging around, but if this is blatantly no longer the correct
option, please let me know!

The final option regarding MD_ROOT was already included in the generic
kernel; so, I guess that's fine to still reference.

I haven't taken a look at the later pages since I wasn't able to build the
kernel. Since I'm not very familiar with FreeBSD, I wouldn't know what to
look for in terms of outdated material. If this page is indeed out of date,
it might be worth adding to the backlog to take a look at the rest of the
SSD material to ensure it isn't old.


Hi Chip,

I believe you are correct; unfortuately, the architecture handbook has 
many places which are woefully out of date, and there is no ETA for fixes.


Could you file a PR or three noting these issues? 
(http://www.freebsd.org/send-pr.html)


Thanks,

Ben Kaduk
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to freebsd-doc-unsubscr...@freebsd.org