Re: Porters Handbook section 4.4

[Warren Block]

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!
___
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: mistakes in documentation (ошибки в документации)

[Warren Block]

If you know of anyone interested in doing a Russian translation, the PO 
translation system makes it significantly easier than in the past:


https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/po-translations.html

On Wed, 14 Jun 2017, Maxim Konovalov wrote:


Hi Max,

On Wed, 14 Jun 2017, 13:01+0300, Rys, Max wrote:


Куда писать про ошибки в документации?

https://www.freebsd.org/doc/ru_RU.KOI8-R/books/handbook/openssh.html

   - "Поскольку файлы *файлы* передаются по сети..."
   - "каждый раз *для* при использовании"
   - "порту соединения переправляются *на* через SSH на определенный"


I fixed these typos -- thanks for reporting.

In future it makes sense to use FreeBSD Bugzilla to report such
issues:

https://bugs.freebsd.org/bugzilla/enter_bug.cgi?product=Documentation

Also, I'd recommend to use English documentation instead as the
Russian translation project has no significant activity for long time.



___
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: Introduction & question / comment regarding source tree documentation

[Warren Block]

On Wed, 1 Mar 2017, Peter Looyenga wrote:


My current drive: I can't help feel that the steps required to obtain the
source tree aren't very well explained, and as a result several people and
up confused. To put it more blunt, this thread is what drove me to try and
take more action:

https://forums.freebsd.org/threads/59919/



My only concern (and actual question): Is this already work in progress by
any chance? I don't mind spending a good amount of time on writing up some
documentation, but I have a little bit of a problem with setting something
up only to find out that it wasn't needed at all.


It is needed.  I have some work already on this related part:
https://reviews.freebsd.org/D7665


Note: I don't mind if I send in suggestions and then see them not getting
accepted, that's all part of the game. But it would be bad for me when I
start working on this, only to discover that someone else was already
working on it so I basically ended up wasting my time.

Hope you guys can give me some pointers on this.


Please see the FDP Primer for general guides:
https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/index.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: Translation Projects - Language: Català

[Warren Block]

On Sun, 15 Jan 2017, Josep Maria Gasset wrote:


 Dear doc members,

Does anyone know if there are anybody is translating handbook & faqs
to Català language and a main web page of Freebsd.org/cat?

Maybe I can contribute to this project.


That would be excellent!  Please see the FDP Quick Start:

https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/overview.html#overview-quick-start

and the PO Translations chapter:

https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/po-translations.html


The Quick Start also lists the mailing lists and IRC channels for help. 
There is also a FreeBSD-Translators mailing list:

https://lists.freebsd.org/mailman/listinfo/freebsd-translators
___
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: Building docs

[Warren Block]

On Fri, 6 Jan 2017, scrat wrote:




On 01/06/17 11:22, Warren Block wrote:

On Fri, 6 Jan 2017, scrat wrote:


I am trying to render the documentation from the svn repo for the docs.

I have followed the fdp-primer as well as I can and installed
textproc/docproj.

Here is what I did

svn checkout https://svn.FreeBSD.org/doc/head ~/doc
cd ~/doc/en_US.ISO8859-1/books/handbook
make FORMATS="html pdf" DESTDIR="~/books/handbook" install


html works

pdf the text is rendered as # ## # etc.

How to fix?


Did you install textproc/docproj as a package or a port?


I installed by ports using synth.  Built from 2017Q1 branch port.


Well, okay, but what I'm trying to determine is whether the options were 
the defaults or not.  The correct fonts for PDF generation should be 
installed when the FOP option is set. Installing fop on its own as a 
separate package might not do that.

___
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: Building docs

[Warren Block]

On Fri, 6 Jan 2017, scrat wrote:


I am trying to render the documentation from the svn repo for the docs.

I have followed the fdp-primer as well as I can and installed 
textproc/docproj.


Here is what I did

svn checkout https://svn.FreeBSD.org/doc/head ~/doc
cd ~/doc/en_US.ISO8859-1/books/handbook
make FORMATS="html pdf" DESTDIR="~/books/handbook" install


html works

pdf the text is rendered as # ## # etc.

How to fix?


Did you install textproc/docproj as a package or a port?

The "#" symbols indicate a missing font, but that should have been 
installed along with docproj.

___
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 does the freebsd-doc-en port install far eastern languages?

[Warren Block]

On Thu, 20 Oct 2016, Gary Aitken wrote:


If I build the misc/freebsd-doc-en port, it installs chinese, japanese, and 
korean
fonts.  Can anyone tell me why?

===>>> The following actions will be taken if you choose to proceed:
   Install misc/freebsd-doc-en



   Install chinese/arphicttf
   Install chinese/ttfm
   Install japanese/font-ipa
   Install korean/nanumfonts-ttf


These are a default dependency for the textproc/docproj port.  Turn
off the TRANSLATOR option in that port to avoid them.
___
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 typos

[Warren Block]

On Wed, 20 Jul 2016, Gilles Kirouac wrote:


Dear writer

About the FreeBSD Handbook
Revision: 48895

Here is a quotation of paragr 17.4.1 p 308

=
user as  /mnt/username . In the following example, replace  username with the 
login name of the user and  usergroup

with the user's primary group:
# mkdir /mnt/ username
# chown username :usergroup  /mnt/username
Suppose a USB thumbdrive is plugged in, and a device  /dev/da0s1 appears. If 
the device is formatted with a FAT

le system, the user can mount it using:
% mount -t msdosfs -o -m=644,-M=755 /dev/da0s1 /mnt/ username
Before the device can be unplugged, it must be unmounted first:
% umount /mnt/ username
After device removal, the system message bu er will show messages similar to 
the following:

=

There are three occurrences of an invalid space (I think) after /mnt/:
the first # line
both % lines

Right?


Well, not in the HTML version.  Are you looking at HTML, PDF, or some 
other output format?


The conversion from one format to another might introduce artifacts like 
extra spaces or other characters.


While copying/pasting, I also found that there is a non ascii character after 
"with a FAT", in the words "first" and "buffer".



Is the blank intended in 19.4.2:
 /dev/zvol/ poolname/dataset


Good work!

Gilles Kirouac, Quebec, Qc

P.S. I am new to Freebsd. I like the Handbook, because it seems up-to-date 
and strikes a balance between too little and too many details. However it is 
always good to expose concepts first. For instance, in zfs, what is a 
dataset? I had to scan the book to understand and still... For now I assume 
that it is something created with zfs create. But many datasets appear 
created by the install procedure. So it is not so clearcut. Not before 19.8 
are ZFS features exposed in a rather reference format. I would hope that the 
definition of pool, vdev, dataset be more clearly exposed early in the 
chapter.


Many of the ZFS terms are defined at the end of the ZFS chapter:
https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/zfs-term.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: Video: On-the-fly validation and proofreading of FreeBSD docs

[Warren Block]

On Wed, 20 Jul 2016, Joseph Mingrone wrote:


Hi,

The flavour of how this works may be easier to describe with a video.

https://youtu.be/rYQv4OvoscY


Because OP is too humble to brag this up, allow me:

He took the output of textproc/igor and integrated it into emacs.  Then 
he went further and added even more, with XML validation.


So now you can work in an editor and get all the proofreading tests from 
igor right there.


Just to make it even more impressive, he wrote instructions for the FDPP 
editors section... which I have not yet looked at, sorry.


There is a minor change needed to igor, which has needed a fresh release 
for a while.  Totally my fault, hope to do that this week.

___
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: request

[Warren Block]

On Mon, 27 Jun 2016, Mohammad Eslami wrote:


hi.
good evening.
i did your instructions for install gnome3 on freebsd on my virtual box.
but when reboot my machine it doesn't boot gnome.
what shall i do?


The freebsd-gnome mailing list at
http://lists.freebsd.org/mailman/listinfo/freebsd-gnome

is probably the place to ask.  If the documentation needs corrections, 
we can do that.


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"

Re: Idea about the handbook

[Warren Block]

On Sun, 22 May 2016, Jason Gorman wrote:


Hey, i've recently become interested in FreeBSD and of course stumbled
across the handbook. Have to say it's brilliant!

One thing however I found slightly annoying is that i've been reading the
handbook in my spare time, and chances are whilst reading it i've been on
either my tablet or my phone. Unfortunately the handbook doesn't seem to be
very mobile or tablet friendly.

My profession is currently a front end developer and I would love to tweak
the CSS file for the handbook, and send it over to you guys to see what you
think.


I think I speak for numerous people when saying we would be very 
interested in that.  The FDP Primer shows how to check out and build the 
docs:

https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/

There is a lot there to digest.  I (and others) can help you get a local 
build of the website working to experiment on.


As an aside, note that we have beta-quality epubs which might be more 
suited to mobile use.  They are on the FTP server now:

ftp://ftp.freebsd.org/pub/FreeBSD/doc/en_US.ISO8859-1/books/handbook/book.epub

The "beta" part is that image links are broken.  I investigated that, 
and it's something to do with the build environment--the links are fine 
when built normally on a developer system.  However, I ran out of time 
to work on it.  It only affects images, which are mostly in the 
installation chapters, so most of the book is usable.



Having the handbook responsive would help a great deal, especially if for
example i'm configuring a system and wanted to lookup the handbook on my
phone for reference.

Let me know if this is something you guys would be interested in.


Absolutely!
___
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: Where did we lurn to spel?

[Warren Block]

On Thu, 28 Apr 2016, Pedro Giffuni wrote:


On 04/28/16 16:36, Warren Block wrote:

On Thu, 28 Apr 2016, Warren Block wrote:


On Thu, 28 Apr 2016, Pedro Giffuni wrote:


Hello;

I just updated locally the textproc/codespell to the latest version
(bugzilla 209128 for the curious), and it finds a *crazy* amount of
issues in code comments.

I can't handle it on my own, indeed I got tired just be checking
sys/arm ! Anyways, here is what I went "thru":

https://people.freebsd.org/~pfg/patches/codespell/


textproc/igor finds many mistakes, and works on text files, man pages,
DocBook, and HTML.  Use of either of these tools is optional, though.

Note: in sys/arm/at91/if_atereg.h, it missed "deines"->"defines".




Yes, I haven't really reviewed them beyond the initial replacement.
The changes kept growing and growing and I had to stop.


Oh, and many of these are contractions, which should be avoided anyway.


Well the main questions are ...

1) Should someone brave just go ahead and commit massively
such cleanups?


It is tempting.


2) Is there a clever review process to go through these?
Phabricator with documentation team, or assume common
sense?


In comments, obvious errors don't need any review.  I saw one change in 
there that changed "safe" to "safely", but the original might have been 
meant as "-safe", like "multiuser-safe".


Those types of changes should be reviewed, and also changes that are not 
to comments, like the output in the last batch.  Maybe the original 
printf output was meant to line up.



3) There are many common issues: is "thru" something we should
accept in comments. How about dont vs don't ?


The old "be generous in what you accept and strict in what you produce" 
saying can apply.  The code is what we produce, and comments should be 
as good as we can make them.  "Thru" is difficult to justify.  "Dont" 
and "cant" could be from trying to avoid an apostrophe.  Just spelling 
out the words instead of using the contraction solves the problem.


We have found in other documentation that bad sections are often copied 
and pasted as templates.  Fixing them avoids later, bigger fixes.

___
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: Where did we lurn to spel?

[Warren Block]

On Thu, 28 Apr 2016, Warren Block wrote:


On Thu, 28 Apr 2016, Pedro Giffuni wrote:


Hello;

I just updated locally the textproc/codespell to the latest version
(bugzilla 209128 for the curious), and it finds a *crazy* amount of
issues in code comments.

I can't handle it on my own, indeed I got tired just be checking
sys/arm ! Anyways, here is what I went "thru":

https://people.freebsd.org/~pfg/patches/codespell/


textproc/igor finds many mistakes, and works on text files, man pages, 
DocBook, and HTML.  Use of either of these tools is optional, though.


Note: in sys/arm/at91/if_atereg.h, it missed "deines"->"defines".


Oh, and many of these are contractions, which should be avoided anyway.
___
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: Where did we lurn to spel?

[Warren Block]

On Thu, 28 Apr 2016, Pedro Giffuni wrote:


Hello;

I just updated locally the textproc/codespell to the latest version
(bugzilla 209128 for the curious), and it finds a *crazy* amount of
issues in code comments.

I can't handle it on my own, indeed I got tired just be checking
sys/arm ! Anyways, here is what I went "thru":

https://people.freebsd.org/~pfg/patches/codespell/


textproc/igor finds many mistakes, and works on text files, man pages, 
DocBook, and HTML.  Use of either of these tools is optional, though.


Note: in sys/arm/at91/if_atereg.h, it missed "deines"->"defines".
___
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: ezjail allow.raw_socket handbook wrong confing

[Warren Block]

On Mon, 25 Apr 2016, Christoph Brinkhaus wrote:


On Mon, Apr 25, 2016 at 05:37:28PM +0200, Philipp Erbelding wrote:

Hello Philipp!


Hi,
I think there is a misunderstanding about the issue here.


"jailname" in both the paragraph and the configuration line are shown in
italic because they are strings that the user is supposed to replace
with the actual jail name.

Would it help to break up that paragraph into shorter sentences?

  When raw network sockets are actually needed in a jail, they can be
  enabled.  Edit the ezjail configuration file for the individual
  jail, /usr/local/etc/ezjail/jailname.  Modify the parameters entry:


Is the problem with the mentioned section not with the "=1" which is no longer 
current?
I found this reference in the forums about it only working without the "=1": 
https://forums.freebsd.org/threads/54365/

Kind regards
Philipp


export jail_testjail1_parameters="allow.raw_sockets=1" is not mentioned
in https://forums.freebsd.org/threads/54365/

But I can confirm that the syntax as
export jail_testjail1_parameters="allow.raw_sockets=1"
works for me.


And for me.  This is from a live, working jail named "icinga" here:

  export jail_icinga_parameters="allow.raw_sockets=1"

It's not clear what the misunderstanding or problem was, or what the 
suggested change is to fix it.

___
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"

"Filesystem" versus "file system"

[Warren Block]

The FDP Primer word list shows only "file system", but does not give any 
context for the usage of that term.


This is a mistake, and it's time to fix it.  We can fix it with a 
compound word, by combining two words into a single word with a more 
specific meaning.


As an example, consider the word "keyboard".  A keyboard is a specific 
thing.  A "key board" could be a number of things, including a wooden 
board with nails for hanging keys.


Likewise, "file system" could mean several things, including a file 
hierarchy or some other system of files.


"Filesystem" is a compound word, a single noun, referring to the 
arrangement of bytes and inodes and clusters and fragments that form a 
place to store files.  This is almost always what we mean in a computer 
context.


I have talked about this in the past, too:
https://lists.freebsd.org/pipermail/freebsd-doc/2012-July/020220.html

It's not getting any better.  People are still not sure what to use.

For now, I only plan to change the word list, making it "filesystem" and 
adding a description for context.  Uses of the two-word form can be 
changed when encountered.

___
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: Small suggestion/question about The Handbook (Sec 2.3.1)

[Warren Block]

On Sat, 2 Apr 2016, Ronald F. Guilmette wrote:



In message <alpine.bsf.2.20.1603312259520.97...@wonkity.com>,
Warren Block <wbl...@wonkity.com> wrote:


The short version:

  Normal images are used to install FreeBSD on a BIOS computer or a
  computer with UEFI "CSM" enabled.

  Installing in UEFI mode requires a uefi image.

That's not hard to include, but will it help the user to decide which
image to download?


Answer:  A little.

As I've already admitted, most of this UEFI stuff is rather entirely
opaque to me... undoubtedly because I haven't invested the time
necessary to scour online documents enough to understand it.  Not
even marginally.  (That's my fault, so mea cupla.)  However given that
that FreeBSD Release Engineering folks are routinely going to all
the trouble to create these full alternate sets of install images,
it seems to me that it would be reasonable to invest at least a
small additional amount of effort to describe for us end lusers
the circumstances under which one of these alternate images would
be either necessary or useful.  Right now, there's nothing.  No
hints whatsoever.


Don't say I never got you anything. :)  Updated in r48525:
https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/bsdinstall-pre.html#bsdinstall-installation-media

It is an even more brief mention than discussed above, but can be 
expanded.

___
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: Small suggestion/question about The Handbook (Sec 2.3.1)

[Warren Block]

On Thu, 31 Mar 2016, Ronald F. Guilmette wrote:



I only look at the docs (e.g. the Handbook) infrequently, e.g.
when I need to refresh my memory about what image(s) I should
be downloading for a new build.

Doing that, just the other day, and then looking at the sets
of images actually available from the FTP sites, I realized that
I've never fully understiood when one should be using one of the
*-uefi-* release images.  (So far, I've never had to use one
myself.)

So anyway, might it be a Good Idea to include some brief verbage
explaining why and when one should be using one of the *-ueui-*
images on this page in the handbook?

  https://www.freebsd.org/doc/handbook/bsdinstall-pre.html


There are several issues that make this potentially complicated to 
explain to the end user.


First, how can the user tell if they need UEFI?  For a standard, it is 
remarkably loose.  The vendors won't tell the users, there are no 
tell-tale identification marks shown during boot.  The setup screens 
aren't standardized.


At present, only 64-bit UEFI computers (the great majority) will work 
with FreeBSD uefi images.  And they will only boot into a 64-bit version 
of FreeBSD.  As far as I know, the uefi images will actually also boot 
on a BIOS computer, so that eases a restriction.


And there is the issue of disabling secure boot.

And most (but not all) UEFI computers are capable of legacy booting a 
normal BIOS-type disk.  Provided you figure out how to enable that. 
"CSM" (compatibility support mode) is a standard term, but it is not 
always used.


The short version:

  Normal images are used to install FreeBSD on a BIOS computer or a
  computer with UEFI "CSM" enabled.

  Installing in UEFI mode requires a uefi image.

That's not hard to include, but will it help the user to decide which 
image to download?

___
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: Bad link in google?

[Warren Block]

On Sun, 20 Mar 2016, Russell Haley wrote:


I googled setting up a VirtualBox vm and the handbook link failed.

My google search:

https://www.google.ca/search?q=freebsd+setting+up+a+virtualbox+virtual+machine=utf-8=utf-8_rd=cr=Gk7uVv2aBMGkjwOC-LuoDQ

The handbook link provided was:
https://www.freebsd.org/doc//handbook/virtualization-guest.html


The first link I see is good:
https://www.freebsd.org/doc/handbook/virtualization-host-virtualbox.html

It would be logical for Google to remove 404 links when they crawl the 
pages, but I don't know what they actually do.

___
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 Porter's Handbook title page (books.xml)

[Warren Block]

On Thu, 3 Mar 2016, Michael Gmelin wrote:





On 02 Mar 2016, at 20:32, Warren Block <wbl...@wonkity.com> wrote:


On Wed, 2 Mar 2016, Michael Gmelin wrote:

Hi,

I just noticed, that the porter's handbook title page still shows
copyright 2014 and a commit from 2014:

https://www.freebsd.org/doc/en/books/porters-handbook/

"Revision: 45423

Copyright © 2000-2014 The FreeBSD Documentation Project
Copyright
Legal Notice
Last modified on 2014-08-08 by rene."

Should I post a patch or is there an automatic process that needs to be
fixed?


The "last modified" date comes from the $FreeBSD$ tag, but only the one in the 
book.xml file.  So it is misleading, and usually not the date of the most recent update 
to the book.  Fixing this would require scanning the document sources for the most recent 
date in the doc toolchain, which is possible, it's just something that needs to be done.

I'll update the copyright, and that will also change the date in book.xml.  So 
it will be correct until one of the other files changes...


Thanks.

I noticed when I forwarded the link to a young talent that the "last changed" 
date of 2014 didn't look encouraging in terms of contributing to a vibrant community.


Agreed.  I've pointed this out in the past with the Handbook.  What 
needs to be done is extract the version string from all of the SRCS 
files:


  make -V SRCS | xargs perl -ne 'print "$2 $1 $3\n" if /\$FreeBSD: \S+? (\S+?) 
(\S+? \S+?) (\S+?) \$/' | sort | tail -n1

Easy to set as a make(1) variable, but more work to implement in 
freebsd-common.xsl.  Help welcome!

___
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 Porter's Handbook title page (books.xml)

[Warren Block]

On Wed, 2 Mar 2016, Michael Gmelin wrote:


Hi,

I just noticed, that the porter's handbook title page still shows
copyright 2014 and a commit from 2014:

https://www.freebsd.org/doc/en/books/porters-handbook/

"Revision: 45423

Copyright © 2000-2014 The FreeBSD Documentation Project
Copyright
Legal Notice
Last modified on 2014-08-08 by rene."

Should I post a patch or is there an automatic process that needs to be
fixed?


The "last modified" date comes from the $FreeBSD$ tag, but only the one 
in the book.xml file.  So it is misleading, and usually not the date of 
the most recent update to the book.  Fixing this would require scanning 
the document sources for the most recent date in the doc toolchain, 
which is possible, it's just something that needs to be done.


I'll update the copyright, and that will also change the date in 
book.xml.  So it will be correct until one of the other files changes...

___
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 suggestion 5.6. The X Display Manager. appologizes, text from email didn't pass

[Warren Block]

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"


The mailing list often strips attachments, especially those that are not 
plain text.  A bug report is best if there are patches or other types of 
attachments: https://bugs.freebsd.org/bugzilla/


Sorry about the difficulty, and we appreciate your work in helping 
improve FreeBSD.  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"

Re: Dead link in handbook

[Warren Block]

On Sat, 20 Feb 2016, Fedde Schaeffer wrote:


Good day,

On
https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html
, in a note under ‘4.5.3.1. Upgrading Ports Using Portmaster’, I found a
link to http://www.freebsd.org/cgi/man.cgi?query=portmaster=8 , at
which no manpage could be found. I believe this is because the default
manpath includes only the base FreeBSD system and not ports, as
https://www.freebsd.org/cgi/man.cgi?query=portmaster=8=FreeBSD+Ports+10.2-RELEASE
and
https://www.freebsd.org/cgi/man.cgi?query=portmaster=8=FreeBSD+10.2-RELEASE+and+Ports
do display it.


Yes, this has been a problem for a while.  I have just committed a 
change that will give a default manpath that includes ports.  The HTML 
document has been rebuilt, so please refresh and test that link again.


Is it difficult to adjust this without unnoticedly making the link 
point to an old version of the page once a new release comes out?


The documents are rebuilt frequently, so this should not be a problem. 
Old archived versions of the documents will have links to older 
releases, but that is pretty much expected for old documents.



Thanks,
Fedde Schaeffer, a long-time laptop Linux (Debianoid) user who was forced
to try out Mac OS X at work and is now curious to try if proper FreeBSD
might suit him


Welcome, and thank you!
___
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: 5.4.6. Monitors : xrandr output missing dash "-" in one section

[Warren Block]

On Sat, 20 Feb 2016, sid -- wrote:

...

Sorry, there are a couple examples of xrandr usage in that section, and 
both look correct.  Can you be more specific about which is wrong, and 
the corrected usage?  A URL or full path to the document or file in 
question would also help to make sure we are looking at the same thing.


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"

Re: Checking FreeBSD kernel with static analyzer

[Warren Block]

On Thu, 18 Feb 2016, Russell Haley wrote:


Thanks warren, send me the csv when you get a chance. I'd really
appreciate it. You implied in previous emails that there is a larger
discussion going on about reviewing the data. Is there a public chat
anywhere? I see this as an excellent learning tool for studying the
code.


The code review is now open: https://reviews.freebsd.org/D5245

The unrestricted use original zip file supplied by PVS contained both 
text and CSV report files.  It is available here:


https://people.freebsd.org/~wblock/files/PVS-Studio-log-freebsd.zip

Thanks again to PVS for providing this!
___
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: Checking FreeBSD kernel with static analyzer

[Warren Block]

On Thu, 18 Feb 2016, Svyatoslav Razmyslov wrote:

I have sent the file in CSV format (PVS-Studio-log-freebsd.csv). Does it work 
for you?


18.02.2016 11:24, Russell Haley пишет:

Svyatoslav,

Is there an output format for the issue report that could be massaged in 
python or lua or the like and submitted or imported through bugzilla? CSV, 
xml, json?


The mailing list stripped the attachment, although the mail direct to me 
included it.  The review has been of the text file.  We can make the CSV 
available.


Automated creation of bug reports from these results might not be too 
useful.  Many are only suspected problems and turn out to be false 
positives.

___
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: Checking FreeBSD kernel with static analyzer

[Warren Block]

On Wed, 17 Feb 2016, Fehmi Noyan ISI via freebsd-doc wrote:


Hi Svyatoslav,
Seems like an interesting report!

Wonder if all those findings will be submitted in the form of bug reports or 
email to individual developers working on the particular project that the bug 
is addressed.


Developers have been reviewing it for the last few days.  This review 
was initially limited to committers in case there were any security 
surprises that needed to be addressed.  That was my idea, and possibly 
not necessary.


Some of the reported items have been identified as actual bugs and 
fixed, and some have been identified as false positives.


The review will be opened up to everyone in the next few days.

I can speak for many when saying we appreciate this review and want to 
thank PVS for providing it.

___
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: Checking FreeBSD kernel with static analyzer

[Warren Block]

Added, thanks!

On Wed, 17 Feb 2016, Svyatoslav Razmyslov wrote:


Hi, Warren.

We've published the article on our site, here is the message from our PR:

Analysis of FreeBSD kernel by PVS-Studio.
The development team of PVS-Studio static code analyzer checked FreeBSD OS 
kernel and published an article , describing the most suspicious 
fragments.


http://www.viva64.com/en/b/0377/

Thanks!

10.02.2016 19:55, Warren Block пишет:

On Wed, 10 Feb 2016, Svyatoslav Razmyslov wrote:

The analysis report (filtered for most interesting messages) is attached, 
you can use it without any restrictions. To use the report, please append 
the beginning of the paths to files with the path to a directory 
containing kernel sources (replace |?| in case of csv).


Our article itself will be ready approximately in a week, we well 
appreciate if you could post about it in a news section on 
www.freebsd.org.


Please notify me or the freebsd-doc mailing list when the article is ready.

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"

Re: Checking FreeBSD kernel with static analyzer

[Warren Block]

On Thu, 11 Feb 2016, Svyatoslav Razmyslov wrote:


Hi, Warren.

I used GitHub repository: https://github.com/freebsd/freebsd
git branch: master

For command: "git rev-list HEAD --count", verified revision is 217717.


Sorry, is that a Subversion revision number?  217717 in our Subversion 
repository dates back to 2011.

___
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: Checking FreeBSD kernel with static analyzer

[Warren Block]

On Wed, 10 Feb 2016, Svyatoslav Razmyslov wrote:


Hello!

I'm an employee of "Program Verification Systems" company. We develop a 
static code analyzer PVS-Studio for C/C++/C# languages. To demonstrate the 
capabilities of our analyzer, we regularly perform analysis of open source 
projects.


Recently we’ve checked FreeBSD kernel and now are planning to write an 
article with examples of errors which we found. You can find a list of 
articles, where we write about check reports of other open-source projects on 
our web-page - http://www.viva64.com/en/a/0084/.


Official site of the analyzer - http://www.viva64.com/en/pvs-studio/

We can also provide a full check report by PVS-Studio if needed. Could you 
also help to distribute the article by posting this news on your web-site?


There might be some interest in this, I will investigate.  Would the 
check report be freely available, without restrictions?


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"

Re: Checking FreeBSD kernel with static analyzer

[Warren Block]

On Wed, 10 Feb 2016, Svyatoslav Razmyslov wrote:

The analysis report (filtered for most interesting messages) is attached, you 
can use it without any restrictions. To use the report, please append the 
beginning of the paths to files with the path to a directory containing 
kernel sources (replace |?| in case of csv).


Our article itself will be ready approximately in a week, we well appreciate 
if you could post about it in a news section on www.freebsd.org.


Please notify me or the freebsd-doc mailing list when the article is 
ready.


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"

Re: Checking FreeBSD kernel with static analyzer

[Warren Block]

On Wed, 10 Feb 2016, Svyatoslav Razmyslov wrote:


Hi, Warren.

The analysis report (filtered for most interesting messages) is attached, you 
can use it without any restrictions. To use the report, please append the 
beginning of the paths to files with the path to a directory containing 
kernel sources (replace |?| in case of csv).


Our article itself will be ready approximately in a week, we well appreciate 
if you could post about it in a news section on www.freebsd.org.


An additional question: which Subversion revision of the FreeBSD kernel 
was checked out for the analysis?


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"

Re: Quick question about handbook template

[Warren Block]

On Fri, 5 Feb 2016, Paweł Wierzbicki wrote:


Hello!

I just wanted to ask, if the "FreeDSD Handbook" is generated using some
sort of a template or is it written by hand?


The question is not quite clear.  The Handbook and other FreeBSD 
documents are written by hand in DocBook XML, then output formats like 
HTML and PDF are rendered from the sources.



I ask, because I want to make similar, but much smaller handbook, and I'm
looking for something I could use.


The FreeBSD documentation system is described here:
https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/
___
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: Spanish Translation of the FAQ

[Warren Block]

On Sun, 31 Jan 2016, Federico Caminiti wrote:


I've finally gotten arround to create a spanish translation of the FAQ.


Thank you!  This message should probably be posted to the 
freebsd-translators list, though.  Other translators have probably 
experienced the same problems.  Or will.


I think some translation teams have lists of translations for common 
words and phrases.



There are two things I'd like to point out, though.

1) A few terms/phrases were not so easy to translate me. When in doubt, I
tried to remain consistent with my previous translations of the Leap
Seconds and NanoBSD articles. This is a list of the translations that were
a bit of a problem and what I translated them to.

- source tree -> arbol de codigo fuente
- release engineering -> ingenieria de lanzamientos
- testers -> testers
- bleeding-edge -> bleeding-edge
- handbook -> manual
- strings attached -> restricciones
- bug / bug fix -> error / corrección de errores
- production quality -> calidad de producción
- tunable -> variable
- resource locks -> primitivas de sincronización
- mirror  (left untranslated)
- unstripped kernel  (left untranslated)

2) Some phrases feature wordplays that are impossible to translate into
spanish. I translated them anyway, but the result can be confusing IMHO.
Examples are:

- How cool is FreeBSD? -> Translated as "¿Que tan frío es FreeBSD?" (In
spanish we don't have a distinction between cool as in "not warm" and cool
as in "awesome").

- Why is it called FreeBSD? -> I believe this can create confussion because
we have two separate terms. Free as in "free beer" translates to "gratis"
and free as in "free speech" translates to "libre".

I don't know if it is possible to add a small note to the translation to
clarify the wordplay, but I think it would help matters.

The current translation diff can be seen at:
https://reviews.freebsd.org/D5153 .

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: Catching up with SVN

[Warren Block]

On Wed, 27 Jan 2016, Federico Caminiti wrote:


Ok, it worked without a hitch. It seems I missed chapter 12.4 of de FDP which 
clearly states that make PO updates a PO file.

Sory for the noise!


Not a problem.  Actually, having that feature tested in the wild is 
really helpful.  Don't hesitate to ask questions when anything is not 
clear.  It helps improve the code and the documentation.


Thanks!


2016-01-22 3:09 GMT-03:00 Warren Block <wbl...@wonkity.com>:
  On Thu, 21 Jan 2016, Federico Caminiti wrote:

Hi,

I'm currently making a spanish translation of the FAQ. Since it's a 
rather
large document its taking a lot of time, though I hope to have it 
completed
soon-ish (more or less next week  if I maintain my current pace). 
The
problem is that, in the meantime, a couple of changes were made to 
the
handbook and I have to catch up with to those changes. In the past 
I ve
dealt with this by recreating the .PO file and just copy/pasting the
translated sentences. This worked because the documents in question 
were as
not huge as the FAQ, but doing this approach now seems kind of 
impractical.

Is there any automated method to update the .PO file while keeping 
the
sentences I've translated intact?


  The PO system is meant to do that automatically.  When you use 'make po' 
and a PO file already exists, the new changes are merged with the existing PO 
file.  A PO editor
  will normally show the new strings to be translated at the top.

  If that is not working, please describe the process you use so we can try 
to debug it.

  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"

Re: Catching up with SVN

[Warren Block]

On Thu, 21 Jan 2016, Federico Caminiti wrote:


Hi,

I'm currently making a spanish translation of the FAQ. Since it's a rather
large document its taking a lot of time, though I hope to have it completed
soon-ish (more or less next week  if I maintain my current pace). The
problem is that, in the meantime, a couple of changes were made to the
handbook and I have to catch up with to those changes. In the past I ve
dealt with this by recreating the .PO file and just copy/pasting the
translated sentences. This worked because the documents in question were as
not huge as the FAQ, but doing this approach now seems kind of impractical.

Is there any automated method to update the .PO file while keeping the
sentences I've translated intact?


The PO system is meant to do that automatically.  When you use 'make po' 
and a PO file already exists, the new changes are merged with the 
existing PO file.  A PO editor will normally show the new strings to be 
translated at the top.


If that is not working, please describe the process you use so we can 
try to debug it.


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"

Re: forums.freebsd.org connection reset, questions email bounced

[Warren Block]

On Mon, 16 Nov 2015, Dwight Walker wrote:


Hi

1) forums.freebsd.org pages reset with 301 permanently moved - I am using 
Firefox 16 on Linux and lynx on FreeBSD 6.2


Recent versions of Firefox are needed to support the HTTPS that is used 
by default.


First, I would strongly suggest upgrading to a supported version of 
FreeBSD.  Support for FreeBSD 6.2 ended seven years ago.


Then upgrade to a current version of Firefox (41, at present).

2) email for questions bounced - freebsd-questi...@freebsd.org - person's 
email did not exist on gmail.com


Sorry, no idea on that.  The message was received by the mailing list.
___
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: Misslinked

[Warren Block]

Committed in 47745.  Thanks!

On Thu, 5 Nov 2015, John Baldwin wrote:


On Friday, August 21, 2015 12:17:38 AM Eneko Gotzon Ares wrote:

Hi Bytes Masters!

Just a humble mac user starting to learn the –wonderful– FreeBSD Handbook.

I found a misdirected link.

The "current release 
” link 
(under 1.2. Welcome to FreeBSD! 
), despite its URL

directs to the "1.3.4. Third Party Programs” section.

I don’t know how to fix it (yet).

Thanks you for your wonderful work!


Looks like this was broken in r41760 when "The Current FreeBSD Release"
section was removed from this chaper in the Handbook (but this link and the
"relnotes" anchor was not).  Should this just point to www.freebsd.org/releases
instead?

___
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] Spanish translation of the NanoBSD article.

[Warren Block]

On Sun, 27 Sep 2015, Federico Caminiti wrote:


Hi, ever since the new translations system emerged, I've gotten arround to
translating the NanoBSD article, in the hopes that someone can review and
commit it. Since this is only a .po file, all anyone should worry about are
the translation strings.

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=203402

Although I'm aware there are very few (if any) spanish language committers.
I'll leave this here, in case there is someone who can take a look at this.


This is awesome!  I'm currently away from my system, but as soon as I 
get back, I'll take the bug to review and commit it.  I do not speak 
Spanish, but online translation tools can be used for review.  As we 
build up new Spanish translations, we will also be able to add new 
reviewers and committers.


Thank you for your work on this!
___
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: Broken Links in fdp-primer 2.2.1.

[Warren Block]

On Wed, 9 Sep 2015, Hoyoung Kim wrote:


Hello.

It seems that there are two broken links in section 2.2.1. of fdp-primer:
https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/tools-optional.html

print/jadetex and print/teTeX lead to 'An Exception Has Occurred'.
I think these are outdated because teTeX is unmaintained now.

Please check this out.
Thank you :)


Removed, thank you.  If there are other general documentation-related 
applications that should be added, please let us know.


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"

Re: Modifying the main web page CSS (D3215)

[Warren Block]

On Tue, 8 Sep 2015, Warren Block wrote:


On Sun, 6 Sep 2015, Fabian Keil wrote:


Warren Block <wbl...@wonkity.com> wrote:

The main web page (https://www.freebsd.org/) is terrible on a wide 
monitor.

Most monitors, really.  The CSS throws away a lot of space and uses tiny
crimped fonts.  Except for  fonts, which are ridiculously overstated.


Also reported as "FreeBSD web site renders very badly" (from 2006):
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=91539

I hope you have the cloud required to improve this situation and
succeed where numerous others failed in the past.


Now committed. :)


And not yet visible due to technical reasons (the Makefile does some 
un-make-like things).  Soon.

___
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: Modifying the main web page CSS (D3215)

[Warren Block]

On Sat, 5 Sep 2015, Allan Jude wrote:


So I created this review of my modifications:

https://reviews.freebsd.org/D3215

Previews of how the main page looks on 1920x1200 and 1024x768 monitors
are here:

http://www.wonkity.com/~wblock/tmp/wide-1920.png
http://www.wonkity.com/~wblock/tmp/wide-1024.png


In your screenshots, the search box (top right) is very small


Found and changed, removing a couple more fixed font size declarations. 
The review and the previews have been updated.



I also wonder about removing the explicit  between the event name
and location in the "upcoming events" column, to make it more
effectively use the space


Possible, certainly, but this particular change is limited to CSS.
___
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

[Warren Block]

On Fri, 4 Sep 2015, Julian H. Stacey wrote:


Lukas Splavec wrote:

Thanks a lot! I would really appreciate any help possible. At the moment I
am trying to make translation software to work and then we can go through
it together.


A list of free on line translator engines in case it helps anyone:
http://www.berklix.org/trans/
Maybe someone might write a shell to call one of the engines on existing
freebsd.org web pages, then freeze them, & rerun every so often.


It's technically possible.  Licenses and copyright would have to be 
considered.



It could bulk auto translate a mass of languages for FreeBSD really fast.
it'd be clunky, & freebsd.org doc project till now uses non HTML
master format


DocBook XML, yes.


& doc tools (that never build for me),


Please contact me publicly or privately about that.  There have been 
problematic ports, but as far as I know, everything should be good now.



Just as some BSD/IX projects have primary & secondary status CPUs,
FreeBSD could do similar with human languages ...  Easily add a
swathe of new auto translated secondary HTML formatted languages.
When/ if enough volunteers offer to improve translations, edit to primary.


We kind of already have that, although the secondary type is where the 
user manually uses Google Translate or one of the other services on one 
of our HTML documents.



Not me though. In 1985 I was contracted to automate Unix src/ translation to 7
languages, but I don't enoy defects & inconsistencies of human languages.


If you would like to try out the PO translation system... :)
___
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: bad url in document

[Warren Block]

On Fri, 4 Sep 2015, Chris Mathews wrote:


http://www.freebsd.org/doc/en_US.ISO8859-1/books/faq/install.html has a
reference to a bad link:
http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/install.html



Searching for "Full instructions on this procedure and a little bit more
about installation issues in general can be found in the" and then clicking
on the URL returns "page not found."


Fixed, 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"

Modifying the main web page CSS (D3215)

[Warren Block]

The main web page (https://www.freebsd.org/) is terrible on a wide monitor. 
Most monitors, really.  The CSS throws away a lot of space and uses tiny 
crimped fonts.  Except for  fonts, which are ridiculously overstated.


Quite some time back, this irritated me enough to stomp through the CSS, 
willfully modifying anything that looked funny.  The result is not perfect, but 
still a huge improvement.


There have been proposals to replace the main page entirely, but that now looks 
like it will take a while.


So I created this review of my modifications:

https://reviews.freebsd.org/D3215

Previews of how the main page looks on 1920x1200 and 1024x768 monitors are 
here:


http://www.wonkity.com/~wblock/tmp/wide-1920.png
http://www.wonkity.com/~wblock/tmp/wide-1024.png

It would be nice to space the four elements across the top more evenly, The 
horizontal scrollbar wrongly implies that there is something to the right. 
Fixes welcome.


I propose to commit this in the next three days unless there are 
complaints or submitted improvements.


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"

Re: Handbook - Typo in Pre-Installation

[Warren Block]

On Sat, 5 Sep 2015, Allan Jude wrote:


On 2015-09-05 20:11, Ali Ghahraei wrote:

Good afternoon.

I just wanted to inform you about an error in the handbook (or at least I
think it is one). In "Pre-Installation Tasks" there is a command for
burning disk images, but it currently is:

# dd if=*FreeBSD-10.0-RELEASE-amd64-memstick.img* of=/dev/*da0* bs=1m conv=sync

And I think it should be:

# dd if=*FreeBSD-10.0-RELEASE-amd64-memstick.img* of=/dev/*da0* bs=1M conv=sync

With a capital m in bs. This is because I tried to use the command and it
returned dd: invalid number: '1m'.

I apologize if my English is not too good, but I'm not from an English-speaking
country. I send you this message because I wanted to help you. I hope it is
useful :)


Only the Linux utilities are sensitive to the case of the unit, but yes,
we should change it in the documentation.


The device name will not be correct on Linux, either.  That is a 
FreeBSD-specific command.  We could add a Linux variation, but it ought 
to explain how to determine the correct device to write.


Incidentally, we should test using conv=sync,noerror,sparse.  The last 
one in particular could make writing memory sticks faster.

___
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

[Warren Block]

On Wed, 2 Sep 2015, Lukas Splavec wrote:


I have joined the freebsd-translators list but got no confirmation yet.
After I followed the instructions in the documentation I encountered some 
problems.
The documentation is pointing to 
http://wonkity.com/~wblock/tmp/translation/overview-quick-start.html which does 
not exist This part is apparently vital as further instructions are
refering to it in quote "The procedure shown in Section 1.2, “Quick Start” is 
assumed to have already been performed" which could not be done.


The PO Translations chapter has been added to the FDP Primer:
https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/po-translations.html

Other things were added and updated.  Please let me know of any problems 
or suggestions.


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"

Re: freebsd documentation help

[Warren Block]

On Wed, 2 Sep 2015, Lukas Splavec wrote:

[please do not top-post, it makes responding more difficult]


I have joined the freebsd-translators list but got no confirmation yet.


Thank you.


After I followed the instructions in the documentation I encountered some 
problems.
The documentation is pointing to 
http://wonkity.com/~wblock/tmp/translation/overview-quick-start.html which does 
not exist This part is apparently vital as further instructions are
refering to it in quote "The procedure shown in Section 1.2, “Quick Start” is 
assumed to have already been performed" which could not be done.


The FreeBSD Documentation Project Primer is at
https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/

The new chapter about PO translations on my web site is a preliminary 
version.  I was hoping to get feedback from translators before actually 
adding it to the FDP.  That might take a while, so if it is causing 
problems, I can remove some of the preliminary things and add it sooner.

___
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

[Warren Block]

On Tue, 1 Sep 2015, Lukas Splavec wrote:


Thanks a lot! I would really appreciate any help possible. At the moment I
am trying to make translation software to work and then we can go through
it together.

On Tue, Sep 1, 2015 at 11:19 PM, Hoyoung Kim  wrote:


I recently started Korean translation and went through some trials and
errors.
Although I'm not an expert, I would like to help you if you need :)


On 09/01/2015 22:15, Lukas Splavec wrote:


Hi,

I would like to help with the documentation of the FreeBSD project. I have
noticed there is currently not a Czech translations being done. Is it
considered to be relevant?


Please join the freebsd-translators mailing list at 
http://lists.freebsd.org/mailman/listinfo/freebsd-translators


This list has been set up specifically for translators to talk about 
techniques and help each other.  It has not had a lot of traffic so far.

However, the PO translation software has only been in place for a week.
___
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

[Warren Block]

On Tue, 1 Sep 2015, Lukas Splavec wrote:


Hi,

I would like to help with the documentation of the FreeBSD project. I have
noticed there is currently not a Czech translations being done. Is it
considered to be relevant?


Yes, at present we do not have a Czech translation, but we would like to 
have one.


Also, we have a new translation system that is being tested right now, 
and would appreciate help with that.  Please see

https://lists.freebsd.org/pipermail/freebsd-translators/2015-August/26.html

Since we do not yet have a Czech language subdirectory, that would have 
to be set up.  But that is something we need, and also I would like to 
document the process, so I can help with that.


Please read the link above.  After that, contact me by email at 
wbl...@freebsd.org, and I can help directly.


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"

Testers needed: PO translation

[Warren Block]

A new PO translation system is in place and ready for basic testing. 
Please see

https://lists.freebsd.org/pipermail/freebsd-translators/2015-August/26.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

PO Translations

[Warren Block]

Pardon for the BCC.  I'm sending this because you are all people who 
expressed an interest in helping to translate FreeBSD documentation, 
either on the freebsd-doc mailing list or privately.


We are now asking for testers for our new PO translation system. 
Please see


https://lists.freebsd.org/pipermail/freebsd-translators/2015-August/26.html

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

Re: Suggestions for porter's handbook on bsd licenced dependency options

[Warren Block]

On Thu, 6 Aug 2015, sid -- wrote:

I'd like to suggest to put in the porter's handbook, bsd licenced 
alternatives to commonly ported gnu-based dependencies.


For instance, to suggest the [radio] option of OPENSSL when the 
program calls on GNUTLS. It would be great to optionally also have 
listed in the handbook, other alternatives to OPENSSL and GNUTLS like 
NSS, POLARSSL and WOLFSSL. If anyone is unsure of what I'm refering 
to, or the description of the Makefile code, please do a make config 
and see the Makefile on /usr/ports/ftp/curl to see the possible 
options.


If the application already supports a choice of sub-applications, it is 
nice when the port provides those same options.


Porters generally do not add functionality to an application.  devd(8) 
is not a drop-in replacement for HAL.  It just offers a similar function 
that can be used for detecting hot-plugged input devices.  Some FreeBSD 
developers added code to allow for that use, see
x11-servers/xorg-server/files/patch-config_devd.c.  Usually, this type 
of work is added upstream, in the application itself.  That makes for 
much less work in the future.  Otherwise, porters have to re-integrate 
the changes with each new version of the application.


As far as suggesting adding options, that would be more of a policy 
thing for the ports people.  It's not something the documentation group 
can add to the Porter's Handbook on our own.

___
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: How can I contact doceng@?

[Warren Block]

On Sat, 1 Aug 2015, Hoyoung Kim wrote:


Hello :)

I'm trying to launch FreeBSD Korean Documentation Project.
I sent a mail to doc...@freebsd.org, after carefully read following instruction:

https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/translations.html#idp60865872

However, I couldn't receive any reply from FreeBSD Documentation Engineering 
Team.
What should I do to contact them?


Your message was seen, it's just difficult to answer right now.  Our 
existing translation system is not meeting our needs, and we are working 
on a new system.  There is no projected date, although I had hoped to 
start tests by now.


So we are (or at least I am) reluctant to encourage people to start 
translating using the old unpleasant system.  But we also do not want to 
turn people away from offering their help.


There were a couple of other things that diverted me over the last 
couple of weeks, but now I'm back to working on the new translation 
system.  When it is ready for testing, it will be announced on the 
freebsd-translators mailing list.  In the meantime, if you would still 
like to start translating with the existing system, we can talk about 
that.


Thanks!
___
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: What is the proper indent style for FDP?

[Warren Block]

On Sat, 18 Jul 2015, Warren Block wrote:


On Sun, 19 Jul 2015, Hoyoung Kim wrote:


Hello. I'm curious about indentation style.
Which is the proper one when dealing with FDP xml files?

The original FDP files follow the style like this:

 paraWe have tried to keep the number of forward references in
   the text to a minimum so that you can read this section of the
   Handbook from front to back with the minimum page flipping
   required./para

This is another example:

   listitem
 paraIntroduce you to X, the unix; windowing system, and
   detail how to configure a desktop environment that makes
   you more productive./para
   /listitem


These are correct.


To add to this, if editing an existing section, see
https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style-guide.html#writing-style-whitespace-changes

In short, whitespace-only changes to existing documents (indenting, 
blank lines, adding spaces) should be kept separate from content 
changes.  Save them in a separate patch, for example.

___
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: hi, about doing some changes to polish docs translation for FreeBSD

[Warren Block]

On Wed, 8 Jul 2015, Wlodzimierz Kraterski wrote:


hi,
I'm trying to reach b...@therek.net who's email is listed as resposible for
polish docs translation but all emails bounce back
Can u help?
r.
wlodek


Some of our translation teams have become inactive.  The existing 
manual translation methods still work, but we are currently reworking 
the translation system.


As a start, please join the freebsd-translators mailing list and repeat 
the question there:

http://lists.freebsd.org/mailman/listinfo/freebsd-translators

Thank you!
___
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: Wrong URL for new Leap Seconds article on www.freebsd.org

[Warren Block]

On Sat, 27 Jun 2015, Hans Ottevanger wrote:


Hi,

The Leap Seconds article linked here:

https://www.freebsd.org/news/newsflash.html

using the URL

https://www.freebsd.org/articles/leap-seconds/index.html

gets nowhere.

The URL

https://www.freebsd.org/doc/en_US.ISO8859-1/articles/leap-seconds/index.html

does work however, so maybe there is still time (!) to change it.


Fixed, thanks!
___
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: documentation - invalid url

[Warren Block]

On Fri, 5 Jun 2015, maxfiedler1...@gmail.com wrote:


Hello,

I'm reading through the handbook online and just realized there is an invalid 
url in chapter 2.4.1. Booting on i386? and amd64; the url to the Plop Boot 
Manager is no longer http://www.plop.at/en/bootmanager.html but now 
http://www.plop.at/en/bootmanagers.html


Fixed, thanks!
___
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

[Warren Block]

On Fri, 3 Apr 2015, Benjamin Kaduk wrote:


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.


Yes.  xorg-server does not use HAL by default any more.  I'm tempted to 
just remove the HAL/DBUS part of the quick start.  Really, the whole 
Xorg installation section needs a rewrite.  I have an outline for that, 
but not the motivation.

___
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

[Warren Block]

On Fri, 3 Apr 2015, Kaio Rafael wrote:


The point here is not about which service needs HAL.

My feedback was that I got an error following the procedure. Probably,
those instruction should be changed to a proper place, such as The X
Display Manager [1]


I would say we should have separate HAL instructions only where it is 
needed.  At present, that is for Gnome and KDE.  For that matter, Gnome 
not automatically installing HAL as a dependency is a bug that should be 
reported to the Gnome port maintainers.

___
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

[Warren Block]

On Fri, 3 Apr 2015, Benedict Reuschling wrote:

Am 03.04.15 um 17:07 schrieb Warren Block:


Yes.  xorg-server does not use HAL by default any more.  I'm
tempted to just remove the HAL/DBUS part of the quick start.
Really, the whole Xorg installation section needs a rewrite.  I
have an outline for that, but not the motivation.


I'd like to see that happen as well, mainly because of my dislike of
the extra HAL dependency. Warren, maybe we can work on this on
Phabricator? If you can provide your outline we can get it moving
towards a handbook patch sooner. Maybe involving the ports people as
well is also helpful because they should know what needs to be in
there (dependency-wise) and what not.


The quick start (which is widely ignored) does have instructions which 
work with the new no-HAL default.


It's been a couple of months since I last worked on the outline, but 
maybe there is a way we can get people to help with it.

___
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: Proposed improvement to LOGGER(1)

[Warren Block]

On Tue, 17 Mar 2015, Raphael Abreu wrote:


Hello everyone,

This is the first time I am sumbitting an e-mail to this list so sorry if I
break any protocols.

I would like to propose an improvement to the LOGGER(1) entry:

https://www.freebsd.org/cgi/man.cgi?query=logger%281%29

Where it reads:

*-f**file*
 Log the specified file.

For clarification it should read:

*-f**file*
 Log the contents of specified file. This option cannot be
combined with a command-line message.

I struggled for some time with this parameter and only understood what was
going on after reading a GNU version:

http://praxis.edoceo.com/man/1/LOGGER

Searching on stackexchange and other sites I could see that mistaking the
meaning of this flag is quite common.

I hope this can be a positve contribuition.


The man page for FreeBSD 11 already has a better description, although 
it does not describe the behavior when both -f and a message are given. 
Even if the copyright of the Linux man page allowed us to copy it 
directly, it does not really describe what happens when both -f and a 
message are given.  Instead, I have committed this original update:

https://svnweb.freebsd.org/base/head/usr.bin/logger/logger.1?r1=280336r2=280335pathrev=280336

This was committed to -CURRENT, and will be MFCed into FreeBSD 10-STABLE 
in a week or so.


Thanks!
___
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: Can I help?

[Warren Block]

On Tue, 10 Feb 2015, R0B_ROD wrote:


Hey everyone.
I want to help with documentation and code (in the far future).


For a start, please look at the FDP Primer:
https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/

That describes how the existing documentation is marked up and built, 
and gives some guidelines that help explain why some things are done in 
a certain way.

___
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: Man page for pkg in release 10.1

[Warren Block]

On Sat, 27 Dec 2014, Chris Van Steenlandt wrote:


Hello,

if I'm posting this in the wrong mailing list, please forward this.

During a fresh install of 10.1, I wanted to consult the man page of pkg from 
the FreeBSD web site;

There I was directed to pkg section 7 man page.


That is the stub version of pkg included with the operating system. 
It only exists to fetch and install the real pkg.  This is described on 
the pkg(7) ('man 7 pkg') man page.


Within that man page a reference to pkg(8) was made where all the pkg 
commands should be described. The link, however, is dead.


Select 8 - Maintenance Commands for the section, and 
FreeBSD 10.1-RELEASE and Ports for the version.  The and Ports is 
the important part, because the real pkg does not exist in the base 
system.


https://www.freebsd.org/cgi/man.cgi?query=pkgapropos=0sektion=0manpath=FreeBSD+10.1-RELEASEarch=defaultformat=html

Also when I type 'man pkg' from my fresh install, I get to see a 
different man page.


It should be the same one shown at the link above.
___
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

New translators mailing list

[Warren Block]

A new mailing list, freebsd-translators@, has been set up to discuss
translation tools and processes.  Everyone with any interest in
translations is encouraged to subscribe:
https://lists.freebsd.org/mailman/listinfo/freebsd-translators

Description:

A discussion list where translators of FreeBSD documents from English 
into other languages can talk about translation methods and tools.  New 
members are asked to introduce themselves and mention the languages they 
are interested in translating.

___
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 section on PXE booting

[Warren Block]

On Tue, 2 Dec 2014, bu...@jameswhitby.org wrote:


At the bottom of section 31.8.2. Configuring the DHCP Server, just above
section 31.8.3. Debugging PXE Problems, the text reads:

Once the edits are saved, enable NFS at boot time by adding the following
line to /etc/rc.conf:

dhcpd_enable=YES

Then, start the DHCP service:

# service isc-dhcpd start

That first line should be :

Once the edits are saved, enable DHCP at boot time by adding the following
line to /etc/rc.conf:


Fixed, thanks!
___
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

New automated test of FreeBSD documentation available

[Warren Block]

A new automated test of the documentation is available through the 
FreeBSD testing project.  See the results at:


https://jenkins.freebsd.org/job/FreeBSD_Doc-igor/

Click Checkstyle Warnings at the upper left to see a list of all 
warnings by file.  Click on a file and the Details tab to see the 
individual warnings.


The No description available. Please upgrade to latest checkstyle 
version message is a known issue: 
https://lists.freebsd.org/pipermail/freebsd-testing/2014-November/000678.html. 
Help to fix that will be welcome.


Please give us feedback on whether this is useful and how it can be 
improved.  Thanks!


___
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: New automated test of FreeBSD documentation available

[Warren Block]

On Sun, 30 Nov 2014, Benedict Reuschling wrote:


Am 30.11.14 um 18:42 schrieb Warren Block:

A new automated test of the documentation is available through the
FreeBSD testing project.  See the results at:

https://jenkins.freebsd.org/job/FreeBSD_Doc-igor/

Click Checkstyle Warnings at the upper left to see a list of all
warnings by file.  Click on a file and the Details tab to see the
individual warnings.

The No description available. Please upgrade to latest checkstyle
version message is a known issue:
https://lists.freebsd.org/pipermail/freebsd-testing/2014-November/000678.html.



Help to fix that will be welcome.


Please give us feedback on whether this is useful and how it can
be improved.  Thanks!




Wow, this is a great start. Thank you for working on integrating
igor's checks into Jenkins. Hopefully, we can expand that into the
translation projects as well. For now, I see a lot of commits coming
that clean up either the false-positives or the real style bugs. ;-)


I forgot to mention that this is all due to excellent work by Li-Wen 
Hsu and the freebsd-testing group.  Thanks to all!

___
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: [RFC] Moving troff only documentation to the doc repository

[Warren Block]

On Sun, 23 Nov 2014, Remko Lodder wrote:

On 23 Nov 2014, at 20:10, Baptiste Daroussin b...@freebsd.org wrote:

Hi all,

I would like to move the troff documentation which is not very useful anymore on
a recent FreeBSD system but still part of history into the doc repository, a
dedicated branch will probably fit (anyone has an idea for the name of the
branch?)

FYI the troff only docs concern:
share/docs/{papers,psd,smm,usd}

Anyone has a concern about that?



Not from me, I actually have never read the documentation.

How about doc-history, or something where we can archive documentation that has
high historic value?


There is the doc archive: https://docs.freebsd.org/doc/
___
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: Missing Man Page entry?

[Warren Block]

On Mon, 3 Nov 2014, Wesley Ellis wrote:


I was reading through the Handbook in preparation to install and found that
the named(8) link returned no entries.

This can be found at:
https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/dirstructure.html

The link in question is:
http://www.FreeBSD.org/cgi/man.cgi?query=namedamp;sektion=8


named(8) is not present in FreeBSD 10.0 or later, the default choice for 
man pages.  BIND was replaced by the Unbound resolver.


Select an earlier release in the dropdown to see named(8):
https://www.freebsd.org/cgi/man.cgi?query=namedapropos=0sektion=0manpath=FreeBSD+9.3-RELEASEarch=defaultformat=html

Or see unbound(8).
___
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: [Bug 194080] New: handbook should mention svnlite

[Warren Block]

On Wed, 1 Oct 2014, Allan Jude wrote:


I was under the impression svnlite was slated to go away.

Do we have an actual plan here, to keep it or kill it for 11?


As far as documentation is concerned, remember that svnlite is not 
present before 10.x.


To my knowledge, svnlite's presence or future is not currently, er, 
plan-based.

___
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

[Warren Block]

On Thu, 14 Aug 2014, Benjamin Kaduk wrote:


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.


Agreed.  Updated, shorter version:

http://www.wonkity.com/~wblock/motd/motd
http://www.wonkity.com/~wblock/motd/motd.diff
___
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

[Warren Block]

On Fri, 5 Sep 2014, Warren Block wrote:


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


And an experimental version that uses VT100/ANSI escape sequences to 
remove the in-band quote marks that many readers will type, and 
highlight those sections with out-of-band underlines:


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

I have no evidence, but suspect the number of people using non-VT100, 
non-ANSI terminal emulations is very small, and those people will 
probably not be bothered by escape sequences that do not render 
correctly.

___
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: ezjail Handbook section

[Warren Block]

On Mon, 25 Aug 2014, John Baldwin wrote:


On Wednesday, August 20, 2014 05:30:12 PM Warren Block wrote:

On Wed, 20 Aug 2014, Warren Block wrote:

On Wed, 20 Aug 2014, John Baldwin wrote:

On Tuesday, August 19, 2014 6:01:54 pm Warren Block wrote:

On Mon, 4 Aug 2014, Warren Block wrote:

Draft version of an ezjail section for the Handbook Jails chapter:
http://www.wonkity.com/~wblock/jails/jails-ezjail.html

This includes a complete setup at the end for running BIND in a jail.
In addition to a complete jail example, it can also serve as an example
of
how to set up BIND now that the old chroot configuration is no more.


Asking for review again of the final version at the link above.  If
there are no major complaints in the next few days, it will be
committed.


It's not clear to me if you need lo1?  If you are using aliases on an
external
interface as you would with a traditional jail then I think you don't
need
the
lo1 interface?


It's there to keep jails from being involved with lo0 on the host.  But I
admit the explanation is fuzzy, and will seek clarification.


Updated.  It now says:

   To keep jail loopback traffic off the host's loopback network
   interface lo0, a second loopback interface is created by adding
   an entry to /etc/rc.conf:...


I guess my question was more why?  This isn't ezjail-specific, and neither
of the other two jail tutorials in this chapter mention lo1.  If having lo1 is
important, then we should explain why and probably do so in the first jail
example and then apply it consistently in all the jail examples.  They why
should detail if this is an optional nice to have or if this is critical to
security and apps can break out of jails otherwise.  My assumption is the
former, but seeing it documented as a mandatory step in the ezjail config
implies the latter to me.


It is not required, but (as I understand it), can prevent problems with 
the host seeing jail loopback traffic.  I'm attempting to find an 
example which shows how the problem appears.

___
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: ezjail Handbook section

[Warren Block]

On Wed, 20 Aug 2014, Warren Block wrote:


On Wed, 20 Aug 2014, John Baldwin wrote:


On Tuesday, August 19, 2014 6:01:54 pm Warren Block wrote:

On Mon, 4 Aug 2014, Warren Block wrote:


Draft version of an ezjail section for the Handbook Jails chapter:
http://www.wonkity.com/~wblock/jails/jails-ezjail.html

This includes a complete setup at the end for running BIND in a jail.
In addition to a complete jail example, it can also serve as an example 
of

how to set up BIND now that the old chroot configuration is no more.


Asking for review again of the final version at the link above.  If
there are no major complaints in the next few days, it will be
committed.


It's not clear to me if you need lo1?  If you are using aliases on an 
external
interface as you would with a traditional jail then I think you don't need 
the

lo1 interface?


It's there to keep jails from being involved with lo0 on the host.  But I 
admit the explanation is fuzzy, and will seek clarification.


Updated.  It now says:

  To keep jail loopback traffic off the host's loopback network
  interface lo0, a second loopback interface is created by adding
  an entry to /etc/rc.conf:...
___
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: ezjail Handbook section

[Warren Block]

On Mon, 4 Aug 2014, Warren Block wrote:


Draft version of an ezjail section for the Handbook Jails chapter:
http://www.wonkity.com/~wblock/jails/jails-ezjail.html

This includes a complete setup at the end for running BIND in a jail.
In addition to a complete jail example, it can also serve as an example of 
how to set up BIND now that the old chroot configuration is no more.


Asking for review again of the final version at the link above.  If 
there are no major complaints in the next few days, it will be 
committed.

___
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

/etc/motd update

[Warren Block]

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

Making it clear that commands are to be typed without quotes is a little 
difficult.  This file is plain text, so no out-of-band highlighting is 
available.  ANSI colors or bold could be used, but the terminal is not 
guaranteed to be able to display them.  The only really clear way would 
be to put commands on a separate line, indented.  That takes up more 
space, maybe not a big deal.


The other issue is whether we should mention the search box on the web 
page, which is not very effective at finding things.


Comments and suggestions welcome.
___
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

[Warren Block]

On Wed, 13 Aug 2014, Brooks Davis wrote:


On Wed, Aug 13, 2014 at 02:23:00PM -0600, 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



Making it clear that commands are to be typed without quotes is a little
difficult.  This file is plain text, so no out-of-band highlighting is
available.  ANSI colors or bold could be used, but the terminal is not
guaranteed to be able to display them.  The only really clear way would
be to put commands on a separate line, indented.  That takes up more
space, maybe not a big deal.

The other issue is whether we should mention the search box on the web
page, which is not very effective at finding things.

Comments and suggestions welcome.


My first thought was that it's definitely better, but too long since 25
rows of text won't fit on the default console.

My second thought was that a better approach might be to replace most of
the contents with a URL like:

http://freebsd.org/getting-started-with-freebsd-11

and a reference to a local copy of the content a release time.  That
would allow unlimited formatting, let us target different user
audiences, and let us improve the online version over time.


That would allow much more vertical space in the actual intro file, 
and clearer explanations:


Type
  man man
for an introduction to manual pages.

Where should the intro file be stored?  /usr/doc is not always present.
___
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

ezjail Handbook section

[Warren Block]

Draft version of an ezjail section for the Handbook Jails chapter:
http://www.wonkity.com/~wblock/jails/jails-ezjail.html

This includes a complete setup at the end for running BIND in a jail.
In addition to a complete jail example, it can also serve as an example 
of how to set up BIND now that the old chroot configuration is no more.

___
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?

[Warren Block]

On Fri, 25 Jul 2014, Craig Rodrigues wrote:


What I'd like to see is an article on freebsd.org either on the wiki
or in the handbook, which compares using apt, yum, rpm, whatever
to pkg.  Is anyone interested in working on an article like this?
I don't have the bandwidth right now.


A person to write that article needs detailed knowledge of pkg and the 
Linux package systems.  I don't have that, but would be willing to help 
you develop an outline for the article.  Having a design like that makes 
it easier to write when time and resources are available.


Writing an article is hard.  Writing a small section on how deleting 
packages is different between pkg and, say, apt, is much easier.  The 
scope is known.

___
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: looking for help to document the new RSS stuff

[Warren Block]

On Sun, 6 Jul 2014, Adrian Chadd wrote:


I'm looking for some help to document the new RSS stuff.

I'm happy writing up some text documentation - shall I just email out
the bits here so I can get some help with markup and such?


Is this for a man page or book or article?

Mailing list threads can make it hard to track suggestions.  Posting a 
diff to phabricator can actually be better, with all the suggestions in 
one place.  Or maybe one doc person can help with an initial version 
first, and then put it on phabricator for review.


But first, let's find out which kind of document.
___
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: looking for help to document the new RSS stuff

[Warren Block]

On Sun, 6 Jul 2014, Adrian Chadd wrote:


On 6 July 2014 12:46, Warren Block wbl...@wonkity.com wrote:

On Sun, 6 Jul 2014, Adrian Chadd wrote:


I'm looking for some help to document the new RSS stuff.

I'm happy writing up some text documentation - shall I just email out
the bits here so I can get some help with markup and such?



Is this for a man page or book or article?


Just manpages to start with. I'll worry about updating the handbook
once I finish the rest of it off (IPv6, UDP, multi-socket, etc.) But
I'd at least like a manpage describing what I'm about to throw into
-HEAD so people can give it a whirl.


Okay.  If it's a new manpage, it helps to find an existing one that is 
similar to use as a template.


I'll contact you privately and we can work up an initial version.

Thanks!
___
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: Bad Example Formatting?

[Warren Block]

On Tue, 1 Jul 2014, Eitan Adler wrote:


Is there a way to signify good example code and bad example code?

For example the latter has a light red background, and clearly says
don't do this while the former has a light green background with a
big checkmark?


I don't know if we have a way to do that short of putting it in a 
caution or warning, but I have learned that it's a mistake to show 
bad examples at all.  Way too many people only look at the examples and 
do not read the explanatory text.  Seemingly all of them.


Given that, my preference would be to have the text explain what to 
avoid (and why), the right way to do it, and then show the right way:


  paraDo not set permissions to literal777/literal!  Use only
the minimum value necessary.  Only the read and execute permissions
for the file owner are needed here:/para

  screenprompt.root; userinputchmod 600 example.sh/userinput/screen

If an example of the wrong way is shown, explaining why it is wrong is 
usually needed.  But the explanation can make it even more of a 
distraction.

___
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

application appearance in HTML

[Warren Block]

The current CSS makes application elements appear in bold text in 
XHTML.  For example:

http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/desktop-browsers.html

This repeated use of bold makes for uncomfortable and fatiguing reading.

Allan and I have searched for less severe forms of highlighting. 
Without resorting to color, there are not many options.  The best I've 
seen so far is font-variant: small-caps;, but that is quickly annoying 
also.


My suggestion at this point is to just remove the CSS entry for 
applications.  The application names are names, and recognizably 
distinct from other words on their own.


Unless there are complaints, I will plan to remove the .application 
entry from docbook.css before the end of this week.

___
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: Clarifying the steps for new committers

[Warren Block]

On Sat, 31 May 2014, Warren Block wrote:

The Committer's Guide has a confusing and difficult to follow set of steps 
for new committers:

http://www.freebsd.org/doc/en_US.ISO8859-1/articles/committers-guide/conventions.html


New version: http://www.wonkity.com/~wblock/committers/conventions.html

Diff: 
http://www.wonkity.com/~wblock/committers/committers-conventions2.diff

___
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: Changes to Wiki articles

[Warren Block]

On Mon, 9 Jun 2014, Sevan / Venture37 wrote:


On 08/06/2014 23:20, Mark Linimon wrote:

See New Accounts underhttps://wiki.freebsd.org/AboutWiki  .  That
should help.


Following the cookbook version I visit UserPreferences page, click Create 
New Page and get You are not allowed to edit this page.


I'm assuming it's possible to get on the contributors group?


The wiki was getting thousands of false signups, so accounts have to be 
set up by clusteradm.  This might only be available to committers.

___
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

Clarifying the steps for new committers

[Warren Block]

The Committer's Guide has a confusing and difficult to follow set of 
steps for new committers:

http://www.freebsd.org/doc/en_US.ISO8859-1/articles/committers-guide/conventions.html

I propose this set of changes:
https://phabric.freebsd.org/D129

Rendered version:
http://www.wonkity.com/~wblock/committers/conventions.html

Feedback welcome!
___
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: SR-IOV Patch Series 3/7: manual pages

[Warren Block]

For iovctl.8, I see is the use of your.  We try to avoid using you 
and your, which is an informal style:

http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/book.html#writing-style-tips

  See the manual page for your PF driver for documentation of
  configuration parameters that are specific to your hardware.

Documentation of is redundant, too, so:

  See the PF driver manual page for configuration parameters specific to
  particular hardware.

(I have not really looked at the markup.  The cross reference (.Xr) to 
iovctl.conf seems correct but rendered as plain text here.  Maybe a 
local thing.)

___
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: is there a complete FreeBSD 9.X/10.X installation guide download?

[Warren Block]

On Mon, 21 Apr 2014, Polytropon wrote:


On Mon, 21 Apr 2014 13:40:02 +0800, wipedrivepro wipedrivepro wrote:

eg in .doc or .pdf format of
https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/bsdinstall.html#bsdinstall-synopsis

it's hard to download it one by one


You can download the full HTML version (in opposite to the
split HTML version you've refered to) from this source:

https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/book.html

This will contain the full handbook.

Additional idea:

Open this page in your web browser and press ^P. Redirect the
output to a file (usually a .ps file). Then use ps2pdf to make
a PDF file from it, and then use pdftk to extract the chapters
you want to have (use a PDF viewer such as xpdf or gv to find
the page numbers representing that range).


The HTML and PDF forms are downloadable directly:
ftp://ftp.freebsd.org/pub/FreeBSD/doc/en_US.ISO8859-1/books/handbook/
___
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 DNS Chapter

[Warren Block]

On Mon, 7 Apr 2014, Brad Davis wrote:


Hi Everyone,

I am slowly working on moderinzing the DNS chapter. One of the first
things I need to fix is to put all the BIND content into its own sub
section. If I do that, the indentation of almost the entire chapter will
need to shift in one level. So I am seeking your advice for how to do
this best. Ideally something like tidy(1) would be able to fix the
indentation for me. What do you think is the best way to solve this
problem?


At present, I'm not aware of an automatic way to do that.  We definitely 
have a need for a program that will take arbitrary DocBook XML files, 
parse them, and reformat them with our indentation rules.


For manual changes, editors/geany will indent or unindent sections while 
keeping track of tabs and spaces.  If configured that way, anyway, and 
I'm not sure of all the settings (but it works here).


Start highlighting and stop when you get to the first line of a screen 
or programlisting element.  Change indent level (ctrl-i, ctrl-u), then 
skip over the screen or programlisting and repeat.


Of course, this should be done as part of a whitespace-only cleanup. 
When the indent changes, lines often need to be rewrapped. 
textproc/igor can help locate problems.

___
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

Rewrite of the Handbook Printing chapter

[Warren Block]

The existing Handbook printing chapter has many weaknesses:
  It does not cover simple setup well.
  It does not cover current devices well.
  It uses some confusing terminology and shows examples for uncommon
  situations.

I've complained about these problems before, but a few months ago, Dru 
asked me to do something about it.


This is a from-scratch rewrite, attempting to address the major problems 
of the old version.


http://www.wonkity.com/~wblock/printing/printing.html
http://www.wonkity.com/~wblock/printing/printing-connections.html
http://www.wonkity.com/~wblock/printing/printing-pdls.html
http://www.wonkity.com/~wblock/printing/printing-direct.html
http://www.wonkity.com/~wblock/printing/printing-lpd.html
http://www.wonkity.com/~wblock/printing/printing-other.html

It adds a quick-start section, simplifies setup, vastly reduces the 
section on shared printers in schools and businesses, and provides a 
framework that allows the addition of other printing systems.  The first 
candidate for that would be CUPS.


Initial responses have been good.  If there are no showstopper 
complaints, I plan to commit this in the next week.


Feedback and testing welcome.  Thanks!
___
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: Downplaying a serious issue

[Warren Block]

On Thu, 3 Apr 2014, Torbjorn Granlund wrote:


Warren Block wbl...@wonkity.com writes:

 Do we?  What should it say?  Please be specific, preferably in the
 form of a PR.  Is this really a doc problem?

Full disclosure.  Don't downplay.  Both the scope and the gravity of the
issue is grossly downplayed here


I asked for specifics.  Grossly is subjective.  What information 
should be given?  What specific configuration and situation fails, 
and in what way?



The truth is that FreeBSD/i386 10 is completely unusable under all three
major type 1 virtualisers.  It should not be used, or one will cause
data loss.


Please post evidence of that.


It might be embarrasing to fess up about bugs, but downplaying serious
issues make people lose confidence.  Which is worst?


I pointed out before that accusing us of things will not produce good 
results.  If you want to discuss concerns politely, without assuming the 
worst of us, I'm interested in that.  Otherwise, I'm going to use my 
time elsewhere.

___
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: Downplaying a serious issue

[Warren Block]

On Thu, 3 Apr 2014, Torbjorn Granlund wrote:


I notice that you seriously downplay the filesystem malfunctioning issue
of FreeBSD/i386 10.0 (and its many betas).


Do we?  What should it say?  Please be specific, preferably in the form 
of a PR.  Is this really a doc problem?



http://www.freebsd.org/releases/10.0R/errata.html

This is not specific to some weird hardware.  It is not specific to
virtualbox.  As I have reported (and been shouted down) it happens under
KVM and Xen.  It happens under Xen+Linux as well as Xen+NetBSD.


Please post links to those reports.


FreeBSD is becoming strange.  I've been using every release since 1.1,
and have liked it.  Now it is unstable, critical bug reports are
ignored, serious problems are being downplayed, the compiler is
terrible.  Did Apple money corrupt a great project?


If you have had rude treatment from someone in the project, I apologize. 
Insulting and accusing the rest of us is not likely to produce good 
results.  Most of us are volunteers, and hard enough to motivate even 
without resentment.

___
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

Heads up: lost replaceable tags

[Warren Block]

During the DocBook 5 conversion, some replaceable tags were lost from 
the XML source.


I've written a script to help check which files contained replaceable 
tags and show the counts before and after the conversion, along with the 
current count.


Instructions and suggestions on using devel/diffuse to replace the 
missing tags are at:

http://www.wonkity.com/~wblock/replaceable/procedure.txt

The script and a sample report:
http://www.wonkity.com/~wblock/replaceable/element-count.sh
http://www.wonkity.com/~wblock/replaceable/report-2014-03-12.txt

Notes: I have fixed the FDP Primer, as the counts in the sample report 
show.  The Handbook printing chapter current count does not apply, 
because that is my rewrite of the old printing chapter with none of the 
previous content.

___
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

docs/187515: userinput inside screen elements is not rendered differently

[Warren Block]

Number: 187515
Category:   docs
Synopsis:   userinput inside screen elements is not rendered differently
Confidential:   no
Severity:   non-critical
Priority:   low
Responsible:freebsd-doc
State:  open
Quarter:
Keywords:   
Date-Required:
Class:  doc-bug
Submitter-Id:   current-users
Arrival-Date:   Thu Mar 13 00:40:00 UTC 2014
Closed-Date:
Last-Modified:
Originator: Warren Block
Release:10-IRRELEVANT
Organization:
Environment:
FreeBSD nomatter 10.0-IRRELEVANT FreeBSD 10.0-IRRELEVANT #15 r263032: Tue Mar 
11 11:14:05 MDT 2014 root@nomatter:/usr/obj/usr/src/sys/NOMATTER  amd64
Description:
Text in userinput tags is not rendered differently from the rest of text in 
screen elements.  As an example, consider the text in 
http://www.freebsd.org/doc/en_US.ISO8859-1/articles/committers-guide/article.html#idp62149040.
  In the screen section after Take a quick note of how it looks before 
moving on to the next step; doing the actual merge:, the prompts, user input, 
and computer output are all rendered in the same font and style.
How-To-Repeat:
Look at 
http://www.freebsd.org/doc/en_US.ISO8859-1/articles/committers-guide/article.html#idp62149040
Fix:


Release-Note:
Audit-Trail:
Unformatted:
___
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

Interactive text analysis

[Warren Block]

http://www.hemingwayapp.com/ shows an interesting way of examining and 
making suggestions on improving text quality.


Ultimately, it would be really nice to see textproc/igor integrated with 
an editor.

___
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

[Warren Block]

On Tue, 4 Mar 2014, James Riggs wrote:


looks like there is a small problem here
https://www.freebsd.org/doc/handbook/x-config.html

section 6.4.2

on the lines
hald_enable=YES
dbus_enable=YES

the underscores are not visible on my browser (chrome on windows)
not sure if this is an issue with the font or something


A font rendering problem, but where?

On FreeBSD, Firefox and Chrome work.  Midori does not show the 
underlines, unless it is zoomed in four or five steps (it does not show 
an actual zoom number).


On Windows, Firefox shows the underline on the first line.  If I force 
it to use my preferred fonts, it shows only the underline on the second 
line.  Chrome does as reported, not showing either.  IE 11 shows both 
underlines.


If I zoom in, the underlines appear in Chrome at 125%.

The question is whether this is something we can fix in the HTML or CSS.
___
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: Processes and Daemons

[Warren Block]

On Sun, 2 Mar 2014, Warren Block wrote:


On Sun, 2 Mar 2014, Thomas Hoffmann wrote:

On Sat, Mar 1, 2014 at 4:10 PM, daniel dallmann 
djdallm...@gmail.comwrote:



I was wondering if the output from top was displayed with two headers on
purpose?

http://www.za.freebsd.org/doc/handbook/basics-processes.html



I'm guessing yes. The first is without ZFS stats (5 lines), the second with
ZFS stats (6 lines). The text describes the 'top' heading as being 5 or 6
lines. So these two header formats are the two users will encounter,
depending on their use or non-use of ZFS.


If intentional, it's a bit misleading.  Better to show just one more 
realistically and note that the output will vary depending on the individual 
system.  It does not seem necessary mention ZFS specifically.


And now I see that it does mention ZFS conditionally.  The second header 
has more detail, but the uptime has been moved more to the right than 
would show in a standard 80-column console.


This patch provides a minimal change:

Index: basics/chapter.xml
===
--- basics/chapter.xml  (revision 44101)
+++ basics/chapter.xml  (working copy)
@@ -3034,13 +3034,7 @@
   paraThe output from man.top.1; is similar:/para

   screenprompt.user; userinputtop/userinput
-last pid: 72257;  load averages:  0.13,  0.09,  0.03up 0+13:38:33  22:39:10
-47 processes:  1 running, 46 sleeping
-CPU states: 12.6% user,  0.0% nice,  7.8% system,  0.0% interrupt, 79.7% idle
-Mem: 36M Active, 5256K Inact, 13M Wired, 6312K Cache, 15M Buf, 408K Free
-Swap: 256M Total, 38M Used, 217M Free, 15% Inuse
-
-last pid:  9609;  load averages:  0.56,  0.45,  0.36  up 
0+00:20:03  10:21:46
+last pid:  9609;  load averages:  0.56,  0.45,  0.36up 0+00:20:03  10:21:46
 107 processes: 2 running, 104 sleeping, 1 zombie
 CPU:  6.2% user,  0.1% nice,  8.2% system,  0.4% interrupt, 85.1% idle
 Mem: 541M Active, 450M Inact, 1333M Wired, 4064K Cache, 1498M Free
@@ -3068,9 +3062,9 @@
figures in the header relate to how many processes are
running, how much memory and swap space has been used, and how
much time the system is spending in different CPU states.  If
-   the system has been formatted with the acronymZFS/acronym
-   file system, the literalARC/literal line provides an
-   indication of how much data was read from the memory cache
+   the acronymZFS/acronym
+   file system module has been loaded, an literalARC/literal line 
indicates
+   how much data was read from the memory cache
instead of from disk./para

   paraBelow the header is a series of columns containing similarIndex: basics/chapter.xml
===
--- basics/chapter.xml  (revision 44101)
+++ basics/chapter.xml  (working copy)
@@ -3034,13 +3034,7 @@
   paraThe output from man.top.1; is similar:/para
 
   screenprompt.user; userinputtop/userinput
-last pid: 72257;  load averages:  0.13,  0.09,  0.03up 0+13:38:33  22:39:10
-47 processes:  1 running, 46 sleeping
-CPU states: 12.6% user,  0.0% nice,  7.8% system,  0.0% interrupt, 79.7% idle
-Mem: 36M Active, 5256K Inact, 13M Wired, 6312K Cache, 15M Buf, 408K Free
-Swap: 256M Total, 38M Used, 217M Free, 15% Inuse
-
-last pid:  9609;  load averages:  0.56,  0.45,  0.36  up 
0+00:20:03  10:21:46
+last pid:  9609;  load averages:  0.56,  0.45,  0.36up 0+00:20:03  10:21:46
 107 processes: 2 running, 104 sleeping, 1 zombie
 CPU:  6.2% user,  0.1% nice,  8.2% system,  0.4% interrupt, 85.1% idle
 Mem: 541M Active, 450M Inact, 1333M Wired, 4064K Cache, 1498M Free
@@ -3068,9 +3062,9 @@
figures in the header relate to how many processes are
running, how much memory and swap space has been used, and how
much time the system is spending in different CPU states.  If
-   the system has been formatted with the acronymZFS/acronym
-   file system, the literalARC/literal line provides an
-   indication of how much data was read from the memory cache
+   the acronymZFS/acronym
+   file system module has been loaded, an literalARC/literal line 
indicates
+   how much data was read from the memory cache
instead of from disk./para
 
   paraBelow the header is a series of columns containing similar
___
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: www/175685: HTTPS does not follow visitor among FreeBSD.org sub-domains

[Warren Block]

On Mon, 24 Feb 2014, Remko Lodder wrote:



On 24 Feb 2014, at 19:30, Allan Jude free...@allanjude.com wrote:


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

From: Allan Jude free...@allanjude.com
To: bug-follo...@freebsd.org
Cc:
Subject: Re: www/175685: HTTPS does not follow visitor among FreeBSD.org 
sub-domains
Date: Mon, 24 Feb 2014 13:25:42 -0500

Another method that has become common in recent years is

a href=//www.freebsd.org/blah/blah

Which will keep the current protocol, be that HTTP or HTTPS

Although I am not sure how some of the more basic browsers like lynx
might handle that. Google et all use it for including javascript to
avoid 'mixed content?.


Cool. That would solve the problem here as well. To what degree should
we support the ?lynx?es out there and cli based browsers ?


Is there an example page we can test?  Maybe this is already supported 
by some.

___
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: ZFS handbook project patch

[Warren Block]

On Thu, 20 Feb 2014, Allan Jude wrote:


I've quickly switch those back to userinput

I used simple logic, if talking about a command in a paragraph, use
command, when doing it in a screen use userinput, as in a
paragraph it is usually never more than a subcommand like commandzfs
send/command


That's correct, IMO.  Semantically, command tags could be used inside 
userinput, but that really does not seem to gain much, and would suggest 
filenames and other content in screen sections would become even more 
complicated.



Also, I just noticed that a bunch of the stuff from my previous zfs
patch didn't get in (I sent 2, a whitespace and a content patch, and
only the whitespace one got in), so I've included the updated zfs send
stuff as well (how to do replication without root)


bcr responded about that, and was waiting for feedback (I think).


IIRC, this means the stuff I wrote for the CARP chapter last week is
wrong with regards to command instead of userinput


...yes.  Fixed.
___
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