Re: Wiki / ZFS Booting

2013-03-07 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Am 07.03.13 23:19, schrieb Glen Barber:
> Hi Cody,
> 
> On Thu, Mar 07, 2013 at 02:07:04PM -0800, Cody Ritts wrote:
>> Hello all,
>> 
>> I have some suggestions for the wiki regarding root on zfs.
>> 
>> In short, I think it would be EXTREMELY helpful to consolidate
>> all of the pages into two.
>> 
>> 1.  Booting to ZFS 2.  Advanced ZFS partitioning
>> 
>> The long story is that I have just spent several days documenting
>> my efforts to get multiple systems to boot from ZFS.  First,
>> thank you to all who have contributed to the wiki, I would not
>> have been able to get it done without you.
>> 
>> That being said these are 11 pages I have found on the wiki:
>> 
>> /RootOnZFS, /RootOnZFS/UFSBoot, /RootOnZFS/ZFSBootPartition, 
>> /RootOnZFS/ZFSBootSlice, /RootOnZFS/GPTZFSBoot, 
>> /RootOnZFS/GPTZFSBoot/Mirror, /RootOnZFS/GPTZFSBoot/RAIDZ1, 
>> /RootOnZFS/GPTZFSBoot/RAIDZ2, /RootOnZFS/GPTZFSBoot/9.0-RELEASE,
>>  /ZFSOnRoot, /ZFSOnRootWithZFSboot
>> 
> 
> Yes, this is a bit excessive... :(
> 

I agree. We should try to reduce the number of ZFS install howtos and
instead put our efforts into bringing it into the handbook. Maybe some
of these howtos are better serves as articles showing alternative ways
of doing these. I know that filesystem layout can be a very personal
thing for many users who want to lay out things their way and none
other. But we could give new users guiding principles on how to do the
basic setup and then help them make the right decisions for their
environment based on the experience gathered from these wiki pages.

>> I don't want to just complain that it should be better, I would
>> like to share the internal documentation that I put together from
>> all of the web pages, man pages, and server testing.
>> 
> 
> Appreciated. :-)
> 

Yes, I had a quick glance at it and I especially liked the first part
using SSH from the beginning.

>> I am not 100% certain I am doing everything the "right" way, but
>> I am 100% CERTAIN that I have COPY/PASTED each and every one of
>> these commands into a FreeBSD-9.1-RELEASE LiveCD shell and then
>> successfully booted.
>> 
> 
> I did not look in-depth at your attached input, but here is a good 
> reference for what Pawel considers the "right way" to do it (for
> various degrees).
> 
> http://blogs.freebsdish.org/pjd/2010/08/06/from-sysinstall-to-zfs-only-configuration/
>
> 
Yeah, tuning the system for ZFS usage (like reserving enough memory
for ARC and such) could also be part of such an article or handbook
chapter.

Regards

Benedict Reuschling
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.8 (Darwin)
Comment: GPGTools - http://gpgtools.org
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlE5F6wACgkQTSZQLkqBk0i5/ACfXvwxIud3KNQTN/l2ff9rko+u
dJ4Aniz+4bzS2xnBXXST6fxcBAPGHqnV
=ewSG
-END PGP SIGNATURE-
___
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"


Intend to remove article: CVSup Advanced Points

2013-04-03 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Hello everyone,

now that CVS/CVSup has been retired more or less, I intend to delete
the following article from our documentation set:

http://www.freebsd.org/doc/en_US.ISO8859-1/articles/cvsup-advanced/

I plan to do by the end of the month, so that people have enough time
to object if they still need the information contained in it. Note
that the article can still be retrieved from SVN history.

Any outcries? ;-)

Regards

Benedict Reuschling
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.8 (Darwin)
Comment: GPGTools - http://gpgtools.org
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlFb8g0ACgkQTSZQLkqBk0h/kgCeJDY54yihVTplyRCMbu49sVbJ
z2oAnjVBX6AeFA0oAHepPdKnSsDab6d7
=uZPW
-END PGP SIGNATURE-
___
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: translating a BSD documentation page

2013-04-11 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Am 11.04.13 17:15, schrieb Eitan Adler:
> On 11 April 2013 11:00, Taras Korenko  wrote:
>> On Thu, Apr 11, 2013 at 05:12:42AM -0700, Fabio Bovelacci wrote:
>>> Dear FreeBSD doc mailing list,
>>> 
>>> I'd like to translate one of your documents in italian. 
>>> (http://www.freebsd.org/doc/en/articles/bsdl-gpl/article.html)
>>>  Where do I send it after the translation? Should I send it
>>> back to you to be submitted to the FreeBSD page?
>>> 
>>> Thanks in advance for your reply.
>> 
>> Try to join The FreeBSD Italian Documentation Project: 
>> http://www.freebsd.org/docproj/translations.html#italian .
> 
> +1.
> 
> If you don't get a reply there let us know, and provide the 
> translation to the mailing list.
> 
> 

You can also use send-pr or the web equivalent:

http://www.freebsd.org/send-pr.html

using the category docs.

Thanks for helping us with translation work!

Regards

Benedict
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.8 (Darwin)
Comment: GPGTools - http://gpgtools.org
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlFnIeEACgkQTSZQLkqBk0hBzwCfUZDeeD3XkbfmfcrXgMPCyKxd
ficAnAjXNf3iEz1E/ycXT01tvtnKbJi5
=k2BS
-END PGP SIGNATURE-
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"


Re: docs/180658: [handbook] add detail to pkgng part of the handbook

2013-10-06 Thread Benedict Reuschling
The following reply was made to PR docs/180658; it has been noted by GNATS.

From: Benedict Reuschling 
To: bug-follo...@freebsd.org, mwlu...@bewilderbeast.blackhelicopters.org
Cc:  
Subject: Re: docs/180658: [handbook] add detail to pkgng part of the handbook
Date: Sun, 06 Oct 2013 17:42:41 +0200

 -BEGIN PGP SIGNED MESSAGE-
 Hash: SHA1
 
 Hi Michael,
 
 Dru Lavigne recently updated the pkgng part of the handbook with the
 instructions you are referring to. Can you check to see whether that
 will solve the PR?
 
 Thanks & best regards
 
 Benedict Reuschling
 FreeBSD Documentation Committer
 -BEGIN PGP SIGNATURE-
 Version: GnuPG v1.4.8 (Darwin)
 Comment: GPGTools - http://gpgtools.org
 Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/
 
 iEYEARECAAYFAlJRhPEACgkQTSZQLkqBk0ihqgCeMhIHT9Mc6PWA93MN8hXWCZvP
 IZAAn0xc3b9wTIu+nASp/hPefSoxyEC+
 =SWkD
 -END PGP SIGNATURE-
___
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: The FreeBSD Polish Documentation Project

2014-02-01 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512

Am 01.02.14 12:40, schrieb Andrzej Talarczyk:
> Recently I've had a look at the Polish translation of the FreeBSD 
> Handbook. I've noticed that it is seriously outdated. The last
> commit was done 7 years ago.
> 
> I tried to contact the maintainer of the FreeBSD Polish
> Documentation Project at b...@therek.net, as listed on the
> freebsd.org's translations page but this e-mail address is no
> longer valid. It looks like the project has been orphaned.
> 
> I'm willing to contribute current Polish translation of (at least
> some of) the FreeBSD docs or even to take over maintaining the
> Polish Translation Project. I would like to ask more experienced
> people here if there is any need for it and how do I do this?
> 

Hello Andrzej,

we have some translation projects that are abandoned or at least do
not receive regular updates. It's great that you are willing to
restart the project and provide updates, which is a huge help.

You should have a look at the Documentation Primer here, which
contains all that you need to know about making changes to our docs:

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

If you have questions about specifics, don't hesitate to ask them here.

You can submit patches to the polish documents as PRs and we'll find
someone to commit then.

Regards

Benedict Reuschling
Documentation Committer

-BEGIN PGP SIGNATURE-
Version: GnuPG/MacGPG2 v2.0.22 (Darwin)
Comment: GPGTools - https://gpgtools.org
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCgAGBQJS7OsRAAoJEAQa31nbPD2LQBwH+QGR4QO1JQkUPo4o5qTju6+7
8t/ysEzBvfEcR2EdeHQITJKQDVQvDsAJo2iyUlLDO7i5dHLv06bAH/STnbcIhYWa
TPoDFr5bUDgz7IEylYakpsLDGSnqgVH7uTDXEUx8WqY34BKtVn5e7NfatnD2wnB3
L7YwiRNp17rJOReyj0iHScRlwCwU2MhkDk5inGGzDtcJ0GX2cNBWfcPCYTAII0EG
9xxDCl0vEr8QJ0sj5LbYDoGTQRWBTvTFMDkz9X3b8YbYKRc1js9C4BadSMkVKwPB
XjtTuBA6RX5rhqmXyG/Ex61+wLEQpxDU6eAoEQO9opm0j1wCp5CgW3mA3wRL5X0=
=Bo4w
-END PGP SIGNATURE-
___
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 doceng member

2014-02-05 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512

Am 05.02.14 08:25, schrieb Hiroki Sato:
> Hi,
> 
> Please welcome Warren Block  as a new doceng 
> member.  As you know already, he has been active in updating our 
> essential documentations such as fdp-primer and handbook as well
> as reviewing submitted patches for a long time.
> 
> The doceng team has been working on infrastructural stuff such as 
> XML framework improvement and maintenance of documentation
> packages, and would like new blood to enhance leadership on
> stimulating more discussion and contribution about our
> documentation set.  I believe Warren is one of the best persons who
> can take the role.  I hope you can also agree.
> 
> The current members of doceng include me, Glen Barber 
> , Marc Fonvieille , Gabor 
> Kovesdan , and Warren Block
> .
> 
> -- Hiroki (doceng hat on)
> 

Congratulations Warren!

Keep up the good work and good luck in your new role.

Best regards
Benedict
-BEGIN PGP SIGNATURE-
Version: GnuPG/MacGPG2 v2.0.22 (Darwin)
Comment: GPGTools - https://gpgtools.org
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCgAGBQJS8hdDAAoJEAQa31nbPD2LlY8IALfYHgxs3PzGTsO5QAyWLeiO
tde5ct1Ui0U4Emg9TUD4InF6DnoLu8EGPuKNGp/y2qaSj1GqblIP/NSVMPhAqfr2
PwzdBibN8DfDy/k9OvAW5h1ih7m2Utjr/0c8NLKH7lukVF7qj+0URsRwLcILaoyK
tkOpbBJeFHcGM6HiHEpoEiF2R4re/GwtzkzUHpgVH+J/5I/0RAocRV18gN3UY8SJ
sFjhNmEUqSa+GgP1bya/ySTfGOyejtu1nIQCIZcA9iuUVt41sVDTD+r2JDg0Whyd
Zpg7QXSzHeY4PwUI6peCFofl0bNKyNTWhDJrifiSUCgEHH7XiD8HLGWKjUZSTxY=
=Mx87
-END PGP SIGNATURE-
___
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: [PATCH] Use a bullet list for general policies

2014-02-08 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512

Am 31.01.14 20:21, schrieb John Baldwin:
> Right now the internal policies page has a paragraph that lists the
> project's policies inline in one big sentence.  I find this harder
> to work with as if I'm looking for a particular policy I have to
> scan the entire sentence.  I think in this case a bulleted list
> works better.  The patch below changes it (note that I haven't
> reordered them, and it may be that there is a better order, though
> I'm not sure what it would be).  Any objections?
> 
> Index: head/en_US.ISO8859-1/htdocs/internal/policies.xml 
> ===
>
> 
- --- head/en_US.ISO8859-1/htdocs/internal/policies.xml   (revision 43698)
> +++ head/en_US.ISO8859-1/htdocs/internal/policies.xml   (working
> copy) @@ -34,25 +34,18 @@
> 
> General Policies
> 
> -Here you will find various things such as the - href="new-account.html">New Account Creation Procedure, -the 
> -Commit Bit Expiration Policy, -the 
> -Core Bylaws, -the - href="resources.html">Commit Bit and Project Resources Policy, 
> -Core's Voting Procedures, -the - href="fortunes.html">Fortune File Policy, -the - href="i18n.html">Internationalization Policy, -the - href="data.html">User Data Policy, -the - href="hats.html">Hats Term Limits Policy, -and the - href="../doc/en_US.ISO8859-1/articles/pr-guidelines/">Problem
> Report Handling Guidelines. + +   href="new-account.html">New Account Creation Procedure +
> Commit Bit Expiration
> Policy +  Core Bylaws +
> Commit Bit and Project Resources
> Policy +  Core's Voting
> Procedures +  Fortune File
> Policy +  Internationalization
> Policy +  User Data
> Policy +  Hats Term Limits
> Policy +   href="../doc/en_US.ISO8859-1/articles/pr-guidelines/">Problem
> Report Handling Guidelines +
> 
> The FreeBSD Documentation Project
> 
> 

Hmm, maybe we should group "Commit Bit Expiration Policy" and "Commit
Bit and Project Resources Policy" together as well as the "Core
Bylaws" with "Core's Voting Procedures" as they are related topics.
The rest is pretty much standalone and I can't find any other better
order. I can also live with Eitan's suggestion of having them in
alphabetical order.

in general, I like the bullet list better than the original list of
links in a long setence.

Regards

Benedict
-BEGIN PGP SIGNATURE-
Version: GnuPG/MacGPG2 v2.0.22 (Darwin)
Comment: GPGTools - https://gpgtools.org
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCgAGBQJS9jhYAAoJEAQa31nbPD2LBFEIAMHEkvOMjr0hr4ImrRt+Gemm
MJf9jTzB3kqEWEe4ZfvHbg0B3/CGk8Ni86d50p3t5xDEQCzK/We7JHMDkOjS9iOr
xIT2KW4aaFgLKWkGUZdNTazhWKvBxDIA5JaBNGtG8073uF6JPJBfWnljsIiEKOAb
x2C5L2tpVb8Yd5W5Oav/sM7OxjwmFUMTBHjjaepwDB0wHiwqviyrA3pjLrGnGNba
YyqLXtRD43EomFb7jUD4b5ypCaTv50giCETkf/qwJ7ZlX/wgVbuG/r1VND70J2IH
m7j+zzf0pnAN6Fg5G7Vb+NxiMm54fsfm1QQtUh1eo6KHUPLgdXh1S2+EKyg+hVw=
=O8Ug
-END PGP SIGNATURE-
___
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: Quick typo fix to fortune

2014-02-15 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512

Am 15.02.14 21:52, schrieb Joe Marcus Clarke:
> Any doc committer feel like making a quick fix or approving me to
> do so:
> 
> http://www.marcuscom.com/downloads/fortunes.diff
> 
> Joe
> 

Approved, good catch!

Regards

Benedict Reuschling
-BEGIN PGP SIGNATURE-
Version: GnuPG/MacGPG2 v2.0.22 (Darwin)
Comment: GPGTools - https://gpgtools.org
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCgAGBQJS/+6bAAoJEAQa31nbPD2LBb0IAJmzrAxWhl77G7mEMf9ynJJJ
H3x+47WVFY/qPzT7ZQdaIL+TCWcURkCtSsAeZ0aCdMufjqggVqtSNTVB1tQGbanH
UdriXFxOhpU8/Jvx/onifw16h7BzHRdoJ3L6vM751A8CBod2ncqH6r8MAwWiAKTU
hfT2jXdRtbVv2kAB+L4RsQdwWdaLm7lekG3qOvSfLeJwTX0EcJ4l6O24MOL5sX8/
f6+MvuvDSdGykAGQ/q8pZDxAJ9H+cw/2ZELjuFsLs1IY8KUoUZScTLXzCs73tWc/
UH3i+bqnYEVITFdtJwSWBVkLfXSKHmWjjJbtioTvu+YBGw4mZVsaBrupIlznVOc=
=hnxM
-END PGP SIGNATURE-
___
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: Translations (was Re: svn commit: r43974 - head/en_US.ISO8859-1/books/handbook/advanced-networking)

2014-02-18 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512

Hi guys,

thanks for your interest in translation. I think that with the
improvements that we can make, we can also make it easier for doc
committers making changes to the doc not worry too much about
translations with regards to whitespace. I could be wrong, but I think
we could combine whitespace and content changes in the future. For
now, my primary focus is on getting the translation process more
automated and easier to catch up.
>>> If there is any way I or other committers can make this easier
>>> for translators, please post on the -doc mailing list or to me 
>>> invididually.
>> 
>> One thing I would recommend is to separate the contents that do
>> not need translation (e.g. tags, entities, etc.) and contents
>> that needs translation.  This way, these contents would serve as
>> a positioning blocks when merging from upstream (English).
> 
> That sounds interesting, and leads well into the next part:
> 
>>> We are also trying to modernize the translation process, and 
>>> automate some of the work that translators are currently forced
>>> to do.  Anyone who would like to help with that is welcome.
>> 
>> That would be great!  How can we help, or is there some kind of
>> TODO list?
> 

Well, I have a couple of loose threads that we need to tie together to
have a complete and mostly automated system.

> There are several things that would be helpful.
> 
> We could use help from people who are experienced with using the 
> .po/.pot/.mo tools (gettext) on other platforms.
> 
> The basic process is to separate all the content from the markup 
> automatically.  Then an editor can be used to add translations, and
> the tool puts a translated file back together from it.  This allows
> the translation program to remember existing translations, so
> translating one document helps translate others.
> 
Yes, that is a good description. I've put a (hopefully) more thorough
description on the wiki page below.

> textproc/itstool is one of the automatic separator programs.  I've
> been somewhat stymied trying to figure out how to get the Python
> libxml2 implementation used by it to find FreeBSD documentation XML
> catalogs. Documentation on this is... let's just say sparse.
> 

Another tool is textproc/po4a that Thomas Abthorpe showed me on one of
the hacker lounges two years ago in Canada. He set up a test project
for a translation into en_GB to see how these tools fit our toolchain.

He send me the following mini-howto, which I extended a bit for a
first commit to the german doc repo recently:


install textproc/po4a
install editors/poedit # optional
install devel/gtranslator #optional
install lokalize # somewhere in kde4, too lazy to look

To prep a new translation, inline, same directory the following works.
Substitute en_GB for the language of your choice.

po4a-gettextize -f xml -m article.sgml -p article.pot # renders to pot
file
#, save as article_en_GB.po
po4a-translate -f xml -m article.sgml -p article_en_GB.po -l
article_en_GB.sgml

Trying to convert to po files with existing translations, the
following should
work providing the sgmlised files match tag for tag

po4a-gettextize -M ISO8859-1 -f xml -m
../../../en_US.ISO8859-1/articles//article.sgml -l
article.sgml -p article_de_DE.po


The biggest problem right that I came across is that after the
translated strings are put back into the xml document, the formatting
is screwed up as the po tools don't know our rules. So, it would we
really cool if we had a tool that does this for us that we could run
after the po4a-translate step.

Another issue is that when I tried po4a-gettextize to extract the
strings from an already existing translation the tool bailed out early
because it can only match string by string. Since the translation and
the english original doc have drifted too far apart and sometimes you
would make two sentences for one english sentence, the tool cannot
cope with it. I don't have a solution for this yet, but it would be a
shame to throw away the already existing translations and not use them
to feed a translation memory.

> The PC-BSD folks are using tools like Pootle, but not for DocBook
> (as far as I know).  They have a web site for translation, useful
> as an example of what can be done: http://pootle.pcbsd.org/
> 
> Benedict (CCed) has made some progress with some of these tools.
> I think there are plans to add a page to the wiki, but don't know
> if it is present yet.

I put everything in the DevSummit wiki page and will start a separate
one with the results from the summit to continue from there:

https://wiki.freebsd.org/201405DevSummit/Translation

Regards

Benedict Reuschling
Documentation Committer
The FreeBSD Project
The FreeBSD Documentation Project

Re: Translations (was Re: svn commit: r43974 - head/en_US.ISO8859-1/books/handbook/advanced-networking)

2014-02-18 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512

Am 18.02.14 20:21, schrieb Remko Lodder:
> 
> On 18 Feb 2014, at 17:17, Warren Block  wrote:
> 
>> On Tue, 18 Feb 2014, Remko Lodder wrote:
>> 
>>> My project at work is not able to keep up with the ?content
>>> spree? that Dru is doing to make things better. Good work, but
>>> a drama for translation teams that need to be in sync first
>>> (and with a train that moves so fast, it will remain out of
>>> date).
>> 
>> Maybe the only way to do that is translate a fixed
>> revision/snapshot. At least with our existing system.
>> 
>>> Do note that translating strings of text might have a dramatic
>>> result; especially in non english versions, one translation
>>> might fit the one line but the other line wouldn?t fit.
>>> Although ofcourse this sounds interesting there is much more to
>>> it. (we do not have a set of predefined things we mention like
>>> $_[LANG] = ?The bird flew over the house?; which is used once
>>> or perhaps twice. We have ?rolling? content like a book.
>> 
>> Translation software like Pootle or poedit generally gives the
>> translator the choice.  Content is shown in chunks, like a title
>> or a sentence.  If one or more translations of that chunk already
>> exist (either from the current document or a different one!), the
>> translator can choose from them, or enter a better translation of
>> their own.
>> 
>> This would radically change the way we do things.  Translators
>> would still need to be aware that source documents had changed,
>> but the translation software would identify parts that were not
>> yet translated. It would ease the job for existing translators
>> and lower the threshold for new translators.
>> 
>> Obviously, this is all vague and ill-defined.  Actual
>> implementations that can be tested would be much more useful.  I
>> believe the tools in textproc/po4a are from Debian and somewhat
>> dated.  textproc/itstool might do a better job separating content
>> if we can just get it to recognize and use our XML catalogs.
>> 
>> An easy way for translators to try it out is the next step.
> 
> Since I do not have -that- much free time at the moment, and a new
> assignment might interfere with my current project, I cannot do the
> heavy lifting of this. I am willing to test this though if someone
> has something that I can try to work with.
> 

You can start with the  I posted earlier. That's what I
used. I recommend you try it with a small article (or you cut one down
to like two 's) to see results early without having to translate
the whole thing. I've used poedit because it is multi-platform, but I
still did an iconv run before commit (if you want to go that far).

The important stuff lies in the po-file later on, which you can also
feed into poedit to build up a translation memory to be used for
another document. For me, this is the most important thing: reuse. I
don't know how many times I've translated "Enter the following
command" and similar phrases. With this new approach, these would be
fed from the translation memory (of course, you can or make small
changes to it like Warren mentioned) and concentrate on the new,
untranslated strings.
The same is true for words like MAKEFILE, names of products, people,
and similar things that don't need to be translated. Sharing these in
a common database across translation projects will ensure a consistent
vocabulary.

Putting these strings out for anyone to translate would be a good
thing to get more translations than we already have. Collecting these
in a database for mixing and matching them to a final translated
document is the next step and would probably be done by someone
familiar with the source material. But the burden of doing the actual
translation work can be put into the hands of people who don't need to
know how our doc toolchain works or even how the xml documents look
like. That is still the work for a doc committer, but the tedious part
could be put on many more shoulders.

Regards
Benedict
-BEGIN PGP SIGNATURE-
Version: GnuPG/MacGPG2 v2.0.22 (Darwin)
Comment: GPGTools - https://gpgtools.org
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCgAGBQJTA7mTAAoJEAQa31nbPD2Lr6UIALg9+edKEk7AgBGY2iyZl4nl
XUgosad0QvaN4OXf9dQjuR2B8KTZfc0PibyeVbjtszBWNBdLDDO5A50JgLKY6Rk2
aghijDZ8C+kR2P5FUQgGe4V1bKdI72OfQphpp/u7jMyacY0ZAgenxPBez5/RVOdA
pt84xMeL19yIfEech0ZwBYVbz1Cb37FMI3AnUlhBUhkANU4IxWEP8ZkvP0XeEHLG
ADhzcNn4/dzVE1y+0fC0S4S0vijq9VT4o2bH+m1U6lGOo3DUZEtLwUFyRkCgrwGa
lOVbdsH4+fSScPb2KT1wjuHK0TRDdvgCPFfDzOnXL0IagsogDBhzLIJKu/lJ2+8=
=+OuL
-END PGP SIGNATURE-
___
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: Translations (was Re: svn commit: r43974 - head/en_US.ISO8859-1/books/handbook/advanced-networking)

2014-02-19 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512

Am 19.02.14 03:30, schrieb Warren Block:
> On Tue, 18 Feb 2014, Benedict Reuschling wrote:
> 
>> Another tool is textproc/po4a that Thomas Abthorpe showed me on
>> one of the hacker lounges two years ago in Canada. He set up a
>> test project for a translation into en_GB to see how these tools
>> fit our toolchain.
>> 
>> He send me the following mini-howto, which I extended a bit for
>> a first commit to the german doc repo recently:
>> 
>>  install textproc/po4a install editors/poedit #
>> optional install devel/gtranslator #optional install lokalize #
>> somewhere in kde4, too lazy to look
>> 
>> To prep a new translation, inline, same directory the following
>> works. Substitute en_GB for the language of your choice.
>> 
>> po4a-gettextize -f xml -m article.sgml -p article.pot # renders
>> to pot file
> 
> I can use poedit to do the translation, but I always get 
> article.pot:7: header field 'Project-Id-Version' still has the
> initial default value
> 

I have this in my pot file header:

"Project-Id-Version: 1\n"
"Language: de\n"

I guess we need to fill these automatically when a new or an updated
translation is created. Maybe we could fill in some values from SVN
(revision comes to mind) or use some kind of auto-incrementing counter
for each new translated document.
These are the things we need to figure out. Another question is: do we
keep those po files holding the translated strings in our doc repo
alongside the translation? Or do only the translation projects keep
them for themselves?

> It does appear to save the translations to article.pot, this is 
> something to do with catalogs.  Manually editing article.pot and
> setting "Language: \n" to "Language: en_GB\n" then complains about
> the "Project-Id-Version" line having a default value.
> 
>> I put everything in the DevSummit wiki page and will start a
>> separate one with the results from the summit to continue from
>> there:
>> 
>> https://wiki.freebsd.org/201405DevSummit/Translation
> 
> The instructions don't seem to be there.  On another page?

Well, I thought about putting them there, but decided against it as I
want the discussion to be open rather than present a solution
beforehand. Maybe someone else knows a better tool. I will demonstrate
it, but will also show the current drawbacks and what I see with my
translator hat on. The process in the mini-howto will get you started
for sure, but it is very open for improvement.

Cheers
Benedict
-BEGIN PGP SIGNATURE-
Version: GnuPG/MacGPG2 v2.0.22 (Darwin)
Comment: GPGTools - https://gpgtools.org
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCgAGBQJTBPqSAAoJEAQa31nbPD2LjGQIALfGCjQy5elI6L7hFxlRVkop
c3OfKQLh8RuemK52ShxrdAv5m4BQng1PPIh28IFWBnEWgTKxUmg0pcMXwtvfvnUG
zbLLmz9CZ2IUmyGJ19CRkqN9ImJZgdbnrxfKuCtRP6Qn83xIPYBTIRqI7c8thDvq
Z6hlYVOnJ4hop+4FSLh6AqMnMTC/P38W1ekZb63RD/qA9YyF9lmO3wP5CNmey0Gk
OWTa7XfY4eFpnokq/KCi6ysH9vYwmrvHirF/9IW6XT9XYjWxTJVN9Gnn07rBJZx3
O2qv6yucUitXOqhaFsZIci6cDt4MNcZzpyMjzqJW0u+pHutbs20zQKvueciBGGk=
=FKUq
-END PGP SIGNATURE-
___
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

2014-02-20 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512

Am 20.02.14 20:08, schrieb Warren Block:
> On Thu, 20 Feb 2014, Allan Jude wrote:
>> 
>> I've quickly switch those back to 
>> 
>> I used simple logic, if talking about a command in a paragraph,
>> use , when doing it in a  use , as in
>> a paragraph it is usually never more than a subcommand like
>> zfs send
> 
> 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  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).
> 

Indeed. But no worries. Now that it is one patch, we can review it
together.

Good work, Allan! The chapter is beginning to look better and better.

Regards

Benedict
-BEGIN PGP SIGNATURE-
Version: GnuPG/MacGPG2 v2.0.22 (Darwin)
Comment: GPGTools - https://gpgtools.org
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCgAGBQJTBmyLAAoJEAQa31nbPD2LjaQH/0yaD9HtNIIvbx6GeOQ8Rstd
p3097q5u0rPSs3bLso5NKE5GXeCOJ5CMWd3ogQRtz8a693c4ImN7IKxz62ZIRhIk
/P3k7/nj1ghrT4e2fDsojSG3LM/D/rN2oQeVL9KijBC8uiGuPLo5GJpIefe/RKpT
6jwH1DLyYD9XmO2HofdCavp3RbnwJBJgfSuEEEbhWUvvcoaFgKLIodK8Aq7egAvI
vWrOBRoahW44B0EAcDUo3PW2A24ghYQO2xm9YIfLL3P0GlOreU+GTzHkivchw44k
fVj6ZReYL64j4e0wAwyFomXCs/mRsaW/mM+PJKCFBT3QlxD2E+VPQXfoa1c+3Io=
=gmZ/
-END PGP SIGNATURE-
___
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 to add new directory in the handbook structure?

2014-09-17 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512

Am 17.09.14 um 18:46 schrieb Allan Jude:
> On 2014-09-17 11:44, RayCherng Yu wrote:
>> Dear all,
>> 
>> I start to contribute the translation of the FreeBSD Handbook to 
>> Traditional Chinese for 3 months. The Traditional Chinese
>> Handbook Project is abandoned for several years. It is outdated.
>> Comparing to the English version, it lacks some chapters. I
>> updated the chapters.ent and sent problem report. But I don't
>> know how too add new directory in the zh_TW.UTF-8 handbook 
>> directory? I copy the new directory from en_US.ISO8859-1 version
>> to zh_TW.UTF-8 handbook directory and change the encoding in
>> chapter.xml in each directory. It don't work. How should I do?
>> 
>> Thanks and Best Regards
>> 
>> RayCherng ___ 
>> 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"
>> 
> 
> Generally you should be fine to create the directories, then do:
> svn add 
> 
> and then use 'svn diff' to generate a patch that will add the 
> directories and files, and submit that attached to a PR.
> 

When you want to build the handbook in your local checkout and the new
chapter you copied does not show up, you need to adjust your Makefile
and add that chapter so that it gets built. Compare the en_US Makefile
with your zh_TW Makefile and see what is missing.

Thanks for working on updating the Traditional Chinese handbook!

Regards

Benedict Reuschling
Documentation Committer
The FreeBSD Project
The FreeBSD Documentation Project
-BEGIN PGP SIGNATURE-
Version: GnuPG/MacGPG2 v2.0.22 (Darwin)
Comment: GPGTools - https://gpgtools.org

iQEcBAEBCgAGBQJUGdfkAAoJEAQa31nbPD2LP/UIAIrorEvTd3wfGZsJJmiqGwHI
g0SU4eqBsNFAMbarPSdDHUirpVgf70MolrNKBi5QlwJt1GosFt4dTCLXYNkg/OtF
qSBtm9gQvB8yuKf+tIGUxxCN1Sc6S3loDsXRgS+fmkeDzmyXrBXKRJCZ6yffpxq6
Qpd0XiMtgdzsDGbAah+ezxQelWA+cdWJ1+x2f6Pg1ID5ibRHW4LdBv96Ady5oXli
qIha3ZbgfoIF0ZwEgv/T1GtzNHYl9+RTbvyl0zcvUl+Hu4wnHeodigq6jI+J6iBB
lX6C3wTJ7gvqfJPpYt5g8hMwMmUocRvQ8KFu/DEAuj9UkfDR97EJQeUz5eUUXFM=
=DkPZ
-END PGP SIGNATURE-
___
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: German and English handbook

2014-10-18 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512

Am 18.10.14 um 03:07 schrieb Martin Bonart via freebsd-doc:
> Hallo, I try to install freeBSD 10.0 in a Vbox for the first time. 
> Now i found same diffentce between the german handbook and the real
>  Instaltionroutine. Now your procedure say, that i have to chekc at
> first the englisch version of the handbook. That is very worst,
> because the contect of booth are total diffent , so that i have
> many throbble to checkout where my diffent is between the real
> whold, the german handbook and the englisch one. What’s now
> correct, what i found on my PC or the gernan handbook or the 
> english one? Example: The portmanager is not in the port-tree on
> the instation via DVD and portupdate, -grade. In the german
> handbook the capter 5.5.4.3. And 5.5.4.4. explane the Portmanager. 
> In the english one, it is the captor 5.5.3.1. Upgrading Ports Using
>  Portmaster. Now my questen: Is the Portmanager still a tool of
> freeBSD 10.0? And which handbook is newer? The english or the
> german one?
> 
> With best gerade, boser
> 

Hello Martin,

thank you for trying FreeBSD. The problem you are describing is based
on the fact that the german handbook translation hasn't caught up the
english (reference) handbook. That is why there is a note there saying
that you should check the english handbook first. There are a few
chapters in the german handbook that are more or less in sync with
their english counterparts. For these, the note is removed. For those
chapters where we simply haven't been able to catch up, you should
refer to the english handbook and follow all the instructions there.

The reason for the lack of up-to-date german translations is mostly a
manpower problem. We need more volunteers to translate the most
important handbook chapters into german (and other languages as well),
so that people can read the instructions in their native language. If
anyone is interested in helping out, contact me directly.

Best regards

Benedict Reuschling
Documentation Committer
The FreeBSD Project
The FreeBSD Documentation Project
-BEGIN PGP SIGNATURE-
Version: GnuPG/MacGPG2 v2.0.22 (Darwin)
Comment: GPGTools - https://gpgtools.org

iQEcBAEBCgAGBQJUQkVRAAoJEAQa31nbPD2L30oH/RvjZWnYtf1DZocpVRDQjN3x
Q3x9eFatuLkCqofF3DgyYNTu1jWdrEcVt7dE3P55pNgmB4Wdj2ano6P/fcx4bz1l
O2uvjmuXfcjKbBgHzVe+wWfczgIOv4Tv+icIcPXFY0+3gOY27mjnoa2hcPD8Y7EF
WxXIgKUG8Dplp9qBFYo82YRKQtsTPoTTYklBU0S95NKczXYn35Y7z2mlTVFiZfr/
vDdD30ePmk+BK3ra6Snl1Ye0iNeU3hy+O6+SWXQMejpy1+lbFNl3+OHnHxlp+CpY
lqFcD9sU9pght7NL/GrJooeeaAk7jaCVQGzga4bT3OPDKlOS6As+wB9CTBEN3No=
=0PlF
-END PGP SIGNATURE-
___
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

2014-11-30 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512

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. ;-)

Regards

Benedict
-BEGIN PGP SIGNATURE-
Version: GnuPG/MacGPG2 v2.0.22 (Darwin)
Comment: GPGTools - https://gpgtools.org

iQEcBAEBCgAGBQJUe3GCAAoJEAQa31nbPD2LEhoH/inSA94/4325AZacLX0Ybe4j
mdCBjnHys6+Uel4GHTG8+rnBakdSDg3DmobLf+lz9JdM6MsA8K3LK3ySc6mjSb65
jt9ndQ5IOGq+WpfNh6n2rks/L22HAfLUCAue35kGA1rZK2ID+9rjWdrwjBcpgVxp
/lvnUE87E3S05r+hmvl0940VlZPazkFeBGetvTn4ej2MOFIxetz0gFUhRQCoTMRC
pKUNFGc2eD6yL4Hoxq2vCvvmuGR7n9sBcwhHTmWXATQZK31vasyYZ0bVKuMalCxN
YvJk9wGyG5cAbLBLkKzh4gcdDCkgjUuUURxjl2M1TjdNCyqFCKzAWFa4vZLqa6A=
=j+ms
-END PGP SIGNATURE-
___
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

2015-04-03 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512

Am 03.04.15 um 17:07 schrieb 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.

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.

Cheers

Benedict
-BEGIN PGP SIGNATURE-
Version: GnuPG/MacGPG2 v2.0.22 (Darwin)
Comment: GPGTools - https://gpgtools.org

iQEcBAEBCgAGBQJVHq5MAAoJEAQa31nbPD2LtB4H/iDuvtk1Gv/34nllOMi859Fy
Fx1dMsrvHdM1GYXyaOkqF1PwlTYiDlja14O7IYJrhsUcx0T19PfP27yEFww+wi8i
OeDNVOq4PiqeS9Wr07zTKJ+Y5WCd63ZXpxn/lm6qH/AIQQttGtPStJJ1U4h2DOHA
rkKyHpqHjO5h2BdmtVMXHKDag7w6oryIGDI9dYoPhvIociWmfg77NYqBfh63XOB5
rHLVXLV6fyzAgOUNXVD152U2a/dQv1xXWmZTB7pfi07XKSFPzRzPfV6EaPLaEAk3
pXo5IRoEawoStMK5EKeJjAR5AZRiq4uR5G4SwPeQXKGsx/QS33WywJlRjHEOqQk=
=lbVj
-END PGP SIGNATURE-
___
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?

2015-07-19 Thread Benedict Reuschling


Am 19.07.15 um 00:57 schrieb Warren Block:
> On Sun, 19 Jul 2015, Hoyoung Kim wrote:
>> Should I manually indent paragraphs after pressing P?
> 
> If the editor does not do it correctly, yes.
> 

It does not do it for the first line in the paragraph, but the rest is
fine. So what I do is I break the line with the  in it when the
number of characters per line are exceeded as normal. Then, I indent the
line below the  manually. Then, you can hit P and the rest of the
line and all those that follow in that paragraph should indent correctly.
It's not perfect, but still better than nothing, especially when there
are long paragraphs.

> Providing a default editor config does not suggest that editor does
> everything correctly.  vim users might be able to help more.  I have yet
> to find any editor that really does our indenting correctly.  Maybe some
> programming can improve on what vim or emacs does by default.

Yes, that would be great. Having some kind of formatter that
knows/follows our indentation rules would be good to have.
___
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 - Typo in Pre-Installation

2015-09-06 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512



Am 06.09.15 um 04:37 schrieb 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.
> 

Right, the device is also different on Macs. PC-BSD has a
comprehensive list of instructions for GUI/non-GUI systems:

http://download.pcbsd.org/iso/10.1-RELEASE/amd64/docs/html/preinstall.html#burning-the-installation-media


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

If we change anything in these instructions, we need to make sure they
are consistent with the ones provided by the release notes. I've used
conv=sync so far without issues, but it might be worth doing some
testing with the other options, too.

Cheers

Benedict
-BEGIN PGP SIGNATURE-
Comment: GPGTools - https://gpgtools.org

iQJ8BAEBCgBmBQJV7BpUXxSAAC4AKGlzc3Vlci1mcHJAbm90YXRpb25zLm9w
ZW5wZ3AuZmlmdGhob3JzZW1hbi5uZXQ5OUI4RkY5NjY1RkY4OTgwM0Y1OERCNTU3
MzNGQjU4NUYyNzc1OEZFAAoJEHM/tYXyd1j+GY8P/iedWRa4cf5U1usXRZ+8C7LN
lJXY7k40wJELVhCi9UWCwybcPoleAy2SAVn3WX2Yv0WnBC7f4pWqNBBR18qvi+BE
Fl04X8Rl4OsePqNKlBQh7yPtcf/cgX7JxALRUbNfv7ociSzW+zhJusQ90mFUYq5J
c0wQFAKCE6FKzi5J3cGFrdX+kJFhXpr1U+3+f+EiH7EEgEOynCwEPpQXHZB0lfcu
tqsuZI8nKYJYYL9IUrbZCbumBGMyv+8mIrgRHNbBprGRA1Th3ujze13NTo3LVrkR
48JextMjxCsZtxkRvv14ZM0OywgvVY7r/02xCgNGYf20dUWvWI2jBItwUk0SpyMR
MU3SrOIeEuQP7dKLfullXDObtFtmMa8fb8Y8DgeyW27KdR3Fc8p1PHjq9jAAnjHT
Urv3WvulNoHvm7f9wvWbTruO5cPittsmJIfpOeJxnXUo+5RF3w9/z/kSeKQdSz8L
EOS0K/8vE89iM8U2SXXTRJksQguJzmT4dPv3YUTfIDHwSwMROhSvqbmL5xvm7HBA
RMjsRGwYerQyWXwcy/bcoYzED+Ei1rU8M5yEqsXpuYApVLOsItAlatTXb7keCLlI
knyMeqNev++eW22FKIX9B8bblaMZybzxaU3Gly6nqlUDK/g0g2rx1sm8cxWYClfh
a7r9jJtbCw1qjhxFSZdj
=0ZuF
-END PGP SIGNATURE-
___
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: Update to 21.7. FreeBSD as a Host with bhyve

2015-10-27 Thread Benedict Reuschling


Am 27.10.15 um 22:35 schrieb hiren panchasara:
> https://www.freebsd.org/doc/handbook/virtualization-host-bhyve.html
> 
> Edit to etc/ttys is no longer needed on -head. (I am not sure about 10).

Just to be clear, are you referring to this line being obsolete on head?

ttyu0 "/usr/libexec/getty 3wire" xterm on secure

I saw other documentation for bhyve that had this line in it:

console "/usr/libexec/getty std.9600" xterm on secure

I'm wondering whether that should replace it...

Can someone elaborate on that?

Benedict

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


Re: Fwd: FreeBSD FTP doc build failed

2016-01-21 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512

Hi Bjoern,

thanks for letting us know about the error. A normal build did not
trigger it, I tested it on my machine.
I've looked for the problematic "kernelconfig-noboot" ID from the
error message you posted. Apparently, that anchor tag was causing
problems, which wblock@ fixed here:

https://svnweb.freebsd.org/doc?view=revision&revision=44373

We have not caught up with translation work to that revision and
therefore, probably due to the latest changes to that chapter a couple
of days ago, the error was triggered (or it has been there for a while
and no one noticed until you sent us the log).

I've committed a fix a few moments ago by basically applying the
changes from r44373.

These sorts of errors are difficult to find when the local builds
don't show them. These kinds of errors are one reason not to translate
from the bottom of the SVN history up until (eventually) hitting the
HEAD revision one day. Instead, the new PO system would always
translate the HEAD rev, but requires much more work when dealing with
huge files and when there are no preexisting PO strings available to
fill in.

Regards

Benedict

Am 21.01.16 um 13:37 schrieb Bjoern A. Zeeb:
> Could someone please have a look what’s wrong with the DE parts
> here and fix it?
> 
> Thanks, /bz
> 
>> Begin forwarded message:
>> 
>> at
>> org.apache.fop.events.ValidationExceptionFactory.createException(Vali
dationExceptionFactory.java:38)
>>
>> 
at
org.apache.fop.events.EventExceptionManager.throwException(EventExceptio
nManager.java:58)
>> at
>> org.apache.fop.events.DefaultEventBroadcaster$1.invoke(DefaultEventBr
oadcaster.java:175)
>>
>> 
at com.sun.proxy.$Proxy6.idNotUnique(Unknown Source)
>> at org.apache.fop.fo.FObj.checkId(FObj.java:205) at
>> org.apache.fop.fo.FObj.startOfNode(FObj.java:186) at
>> org.apache.fop.fo.flow.Inline.startOfNode(Inline.java:77) at
>> org.apache.fop.fo.FOTreeBuilder$MainFOHandler.startElement(FOTreeBuil
der.java:337)
>>
>> 
at org.apache.fop.fo.FOTreeBuilder.startElement(FOTreeBuilder.java:179)
>> at
>> org.apache.xalan.transformer.TransformerIdentityImpl.startElement(Tra
nsformerIdentityImpl.java:1072)
>>
>> 
at org.apache.xerces.parsers.AbstractSAXParser.startElement(Unknown Sour
ce)
>> at
>> org.apache.xerces.xinclude.XIncludeHandler.startElement(Unknown
>> Source) at
>> org.apache.xerces.impl.XMLNSDocumentScannerImpl.scanStartElement(Unkn
own
>> Source) at
>> org.apache.xerces.impl.XMLDocumentFragmentScannerImpl$FragmentContent
Dispatcher.dispatch(Unknown
>> Source) at
>> org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanDocument(Un
known
>> Source) at
>> org.apache.xerces.parsers.XML11Configuration.parse(Unknown
>> Source) at
>> org.apache.xerces.parsers.XML11Configuration.parse(Unknown
>> Source) at org.apache.xerces.parsers.XMLParser.parse(Unknown
>> Source) at
>> org.apache.xerces.parsers.AbstractSAXParser.parse(Unknown
>> Source) at
>> org.apache.xerces.jaxp.SAXParserImpl$JAXPSAXParser.parse(Unknown
>> Source) at
>> org.apache.xalan.transformer.TransformerIdentityImpl.transform(Transf
ormerIdentityImpl.java:484)
>>
>> 
... 4 more
>> 
>> -
>> 
>> javax.xml.transform.TransformerException:
>> org.apache.fop.fo.ValidationException: Property ID
>> "kernelconfig-noboot" (found on "fo:inline") previously used; ID
>> values must be unique within a document! (See position 9552:692) 
>> at
>> org.apache.xalan.transformer.TransformerIdentityImpl.transform(Transf
ormerIdentityImpl.java:501)
>>
>> 
at org.apache.fop.cli.InputHandler.transformTo(InputHandler.java:285)
>> at
>> org.apache.fop.cli.InputHandler.renderTo(InputHandler.java:115) 
>> at org.apache.fop.cli.Main.startFOP(Main.java:186) at
>> org.apache.fop.cli.Main.main(Main.java:217) Caused by:
>> org.apache.fop.fo.ValidationException: Property ID
>> "kernelconfig-noboot" (found on "fo:inline") previously used; ID
>> values must be unique within a document! (See position 9552:692) 
>> at
>> org.apache.fop.events.ValidationExceptionFactory.createException(Vali
dationExceptionFactory.java:38)
>>
>> 
at
org.apache.fop.events.EventExceptionManager.throwException(EventExceptio
nManager.java:58)
>> at
>> org.apache.fop.events.DefaultEventBroadcaster$1.invoke(DefaultEventBr
oadcaster.java:175)
>>
>> 
at com.sun.proxy.$Proxy6.idNotUnique(Unknown Source)
>> at org.apache.fop.fo.FObj.checkId(FObj.java:205) at
>> org.apache.fop.fo.FObj.startOfNode(FObj.java:186) at
>> org.apache.fop.fo.flow.Inline.startOfNode(Inline.java:77) at
>> org.apache.fop.fo.FOTreeBuilder$MainFOHandler.startElement(FOTreeBuil
der.java:337)
>>
>> 
at org.apache.fop.fo.FOTreeBuilder.startElement(FOTreeBuilder.java:179)
>> at
>> org.apache.xalan.transformer.TransformerIdentityImpl.startElement(Tra
nsformerIdentityImpl.java:1072)
>>
>> 
at org.apache.xerces.parsers.AbstractSAXParser.startElement(Unknown Sour
ce)
>> at
>> org.apache.xerces.xinclude.XIncludeHandler.startElement(Unknown
>> Source) at
>> org.apache.xerces.impl.XMLNSDocumentSc

Re: bhyve setup documentation bug

2016-09-06 Thread Benedict Reuschling
Hello Nathan,

that is indeed a bug. I will commit a fix for it soon, so that the
versions are synchronized.

Thanks for reporting it.

Regards

Benedict

Am 06.09.16 um 16:00 schrieb Nathan Dautenhahn:
> Hi All-
> 
> Just going through bhyve setup and there is a minor inconvenient bug in the 
> description on getting a FreeBSD ISO booted.
> 
> Page: 
> https://www.freebsd.org/doc/en/books/handbook/virtualization-host-bhyve.html
> 
> In section 21.7.2:
> 
> There is a command line that fetches an ISO:
> 
> fetch 
> ftp://ftp.freebsd.org/pub/FreeBSD/releases/ISO-IMAGES/10.2/FreeBSD-10.2-RELEASE-amd64-bootonly.iso
> 
> Then there is a command that runs the simple script:
> 
> sh /usr/share/examples/bhyve/vmrun.sh -c 4 -m 1024M -t tap0 -d guest.img -i 
> -I FreeBSD-10.0-RELEASE-amd64-bootonly.iso guestname
> 
> The file names are different. I suppose if you want to make sure your readers 
> are reading in detail…
> 
> Cheers,
> — :: Nathan Dautenhahn ::
> 
> 
> 




signature.asc
Description: OpenPGP digital signature


Re: freebsd-update and kernels

2016-11-12 Thread Benedict Reuschling
Hello Adam,

thank you for your suggestions to improve that chapter of the handbook.

Warren is currently working on an upgrade/rewrite of another section in
that chapter which might touch/overlap with your suggestions.

Here is the review for it:

https://reviews.freebsd.org/D7665

You're welcome to leave comments there if you think that will help get
that chapter back into shape.

Regards

Benedict

Am 11.11.16 um 23:51 schrieb Adam Weinberger:
> Hi, doc folks. Can someone please take a look at section 23.2.3 of the 
> handbook?
> 
> At multiple points in 23.2.3.1, and in the nextboot instructions, it tells 
> users that the GENERIC kernel will be updated if it lives in /boot/GENERIC. 
> AFAICT, freebsd-update will only update the GENERIC kernel if it lives in 
> /boot/kernel, NOT /boot/GENERIC.
> 
> At best, running "nextboot -k GENERIC" after following the instructions will 
> boot an old, non-updated kernel. At worst (i.e., if people follow the 
> instructions given), they will attempt to boot a kernel that doesn't exist.
> 
> Shouldn't users be told to keep GENERIC in /boot/kernel, where freebsd-update 
> will actually update it, and to install custom kernels into /boot/SOMENAME?
> 
> 
> I'd suggest changing that nextboot line to be "nextboot -k kernel".
> 
> Then, I'd suggest replacing the first paragraph of 23.2.3.1 with something 
> like this:
> 
> """
> Before using freebsd-update, ensure that a copy of the GENERIC kernel exists 
> in /boot/GENERIC as a backup in case anything goes wrong.
> 
> freebsd-update will update the GENERIC kernel, but only if it is installed 
> into /boot/kernel and only if it is completely unmodified. If a custom kernel 
> has only been built once, [... etc]
> """
> 
> And in the last sentence of that section, change /boot/GENERIC to 
> /boot/kernel.
> 
> # Adam
> 
> 



signature.asc
Description: OpenPGP digital signature


Re: Samba documentation update

2017-09-25 Thread Benedict Reuschling
Hello Jonathan,

thank you for your report. I just committed an update, so that the link
points to the current version 4.6 of Samba.

It will take a bit until the website with reflect the change.

Regards

Benedict Reuschling

Am 25.09.17 um 20:14 schrieb Jonathan Lisic:
> Hi Again,
> 
> I found another issue with the online documentation:
> 
> https://www.freebsd.org/doc/handbook/network-samba.html
> 
> Paragraph 3, sentence one is both a dead link and points to a non-existent 
> package in at least pkg ‘net/samba43’.  This should be updated to a more 
> recent samba package.
> 
> Thanks,
> 
> Jonathan Lisic



signature.asc
Description: OpenPGP digital signature


Re: New story for the home page

2017-11-19 Thread Benedict Reuschling
Hello Mateusz,

I just added it to the Press section on the homepage. It will appear
there in a few hours once the website has been rebuilt.

Thanks for suggesting it.

Regards

Benedict Reuschling

Am 19.11.17 um 00:47 schrieb Mateusz Piotrowski:
> Hello,
> 
> I stumbled upon this post:
> http://blog.synergysky.com/whydidwebuildoursolutionontopof_freebsd
> 
> Maybe it is interesting enough to put it in the PRESS section on the
> FreeBSD home page.
> 
> Cheers,
> 
> Mateusz Piotrowski
> 
> ___
> 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"



signature.asc
Description: OpenPGP digital signature


Re: Synergy Sky piece promoting FreeBSD

2017-11-19 Thread Benedict Reuschling
Hello Mark,

we've been contacted my multiple people independently about this. I've
just committed a change so that it appears on the Press section of the
FreeBSD.org website once the next build cycle is complete.

Thank you for the suggestion.

Regards

Benedict Reuschling

Am 18.11.17 um 21:51 schrieb Mark Blackman:
> I’d suggest adding this to the news section on the FreeBSD site
> 
> http://blog.synergysky.com/whydidwebuildoursolutionontopof_freebsd 
> <http://blog.synergysky.com/whydidwebuildoursolutionontopof_freebsd>
> 
> - Mark
> ___
> 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"
> 



signature.asc
Description: OpenPGP digital signature


Re: Possible error in handbook

2018-02-21 Thread Benedict Reuschling


Am 20.02.18 um 12:34 schrieb Robert F:
> Hello,
> 
> I've noticed that the handbook page on XDM contains a reference to that 
> package's config file, in the line below:
> 
> "To configure XDM to listen for any remote connection, comment out the 
> DisplayManager.requestPort line in /usr/local/lib/X11/xdm/xdm-config..."
> 
> while the file seems to be located somewhere else (at least, for me), as  
> /usr/local/etc/X11/xdm/xdm-config.
> 
> Thank you,
> Robert Fuller
> https://github.com/fullerrc
> https://www.linkedin.com/in/rcgfuller
> 
> 

Hello Robert,

indeed, I just confirmed it on another machine. I've committed a fix
with the corrected path and it appear in the handbook soon.

Thanks for letting us know.

Regards

Benedict



signature.asc
Description: OpenPGP digital signature


Re: The FreeBSD Handbook has screenshots that there are no in installation of FreeBSD 11.1 and FreeBSD 11.2

2018-07-08 Thread Benedict Reuschling


Am 08.07.18 um 20:21 schrieb Supreme Ninja:
>>
>> Hi,
>>>
>>> The FreeBSD Handbook has screenshots that there are no in installation of
>>> FreeBSD 11.1 and FreeBSD 11.2: https://forums.freebsd.o
>>> rg/threads/part-of-freebsd-handbook-are-outdated.66584/#post-393716
>>
>>
>>
>> The correct link is this: https://forums.freebsd.
>> org/threads/part-of-freebsd-handbook-are-outdated.66584/
>>
> 
> 
> Someone?

Can you file a PR in bugzilla and describe exactly which screenshots are
missing, outdated, or wrong? I can discern that from the forum post.

Thank you for letting us know.

Regards,
Benedict



signature.asc
Description: OpenPGP digital signature


Re: The Italian translation has not been updated since 2008

2018-08-09 Thread Benedict Reuschling


Am 09.08.18 um 09:43 schrieb Alex Dupre:
> Guido Falsi wrote:
>> Being Italian and being a committer I could try to help in this regard.
>> Being just one person I'd make slow progress, but it's better than no
>> progress at all!
> 
> The translation project was done by the GUFI and lead by me in the past,
> but it's really a huge work and the enthusiasm and time lowered to zero
> in the last years. I don't think that a single person can do much, but
> you are welcome.
> 
>> What requirements are there to help updating translations? Is there a
>> translator's guide?
> 
> https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/index.html
> 

And more specificially, the PO translation chapter:

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

It would be great to see Italian translations coming back. Let us know
if you need help.

Regards,
Benedict



signature.asc
Description: OpenPGP digital signature


Requesting a doc commit bit for Mateusz Piotrowski

2018-08-15 Thread Benedict Reuschling
Dear DocEng Team,

I would like to propose Mateusz Piotrowski (0mp@) for a documentation
commit bit, with me has his mentor. He has already made the following
doc commits with approval from doc committers:

- http://freshbsd.org/commit/freebsd/r337835
- http://freshbsd.org/commit/freebsd/r337821
- http://freshbsd.org/commit/freebsd/r337377
- http://freshbsd.org/commit/freebsd/r337040
- http://freshbsd.org/commit/freebsd/r336584
- http://freshbsd.org/commit/freebsd/r336567
- http://freshbsd.org/commit/freebsd/r336483

Mateusz is interested in various parts of the doc tree and would be a
valuable help for us.

I released one of my mentees, Sevan Janiyan, a few minutes ago and feel
capable enough to mentor Matheusz alone since we're both in the same
timezone. However, if you think that a co-mentor is appropriate, I'll
accept that, too.

Thank you for your consideration.

Best regards,
Benedict Reuschling



signature.asc
Description: OpenPGP digital signature


Re: Requesting a doc commit bit for Mateusz Piotrowski

2018-08-15 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512

Oops, that obviously should go to a different group.

Alas, it could serve as an example for others to mentor someone for a
doc bit and how to request that. ;-)

Anyway, sorry for the noise.

Benedict

Am 15.08.18 um 22:15 schrieb Benedict Reuschling:
> Dear DocEng Team,
> 
> I would like to propose Mateusz Piotrowski (0mp@) for a
> documentation commit bit, with me has his mentor. He has already
> made the following doc commits with approval from doc committers:
> 
> - http://freshbsd.org/commit/freebsd/r337835 -
> http://freshbsd.org/commit/freebsd/r337821 -
> http://freshbsd.org/commit/freebsd/r337377 -
> http://freshbsd.org/commit/freebsd/r337040 -
> http://freshbsd.org/commit/freebsd/r336584 -
> http://freshbsd.org/commit/freebsd/r336567 -
> http://freshbsd.org/commit/freebsd/r336483
> 
> Mateusz is interested in various parts of the doc tree and would be
> a valuable help for us.
> 
> I released one of my mentees, Sevan Janiyan, a few minutes ago and
> feel capable enough to mentor Matheusz alone since we're both in
> the same timezone. However, if you think that a co-mentor is
> appropriate, I'll accept that, too.
> 
> Thank you for your consideration.
> 
> Best regards, Benedict Reuschling
> 
-BEGIN PGP SIGNATURE-

iQEzBAEBCgAdFiEEwXonQDvNfP/33IoBVXQ7/QHhjTUFAlt0mRYACgkQVXQ7/QHh
jTUt6Af+KiaWi4cxbEduMeDtgjyKD2lvW8TsolcoS6C1nk6NuVK8kysTP0uIQXdr
hxQSHlWkG8HeM3RYYmRB2s7NV0gDBBIegFtjig16QXrTMJpzWH//UCJ4dlKXMycz
YNfSJwGSQK+lFNg0rj+QaWnoFjqHCP5EvXGl0BBoO/in1FV+K7XdZFC4Pq51zh3S
+NASEZbu/6xAhE3Ehb/kdGCiN5fnCWxr+BfGFR9B6B8J9+iplol6oFueo3g9f3Z8
orSmuiSh/unohxUxuspUIErrBDeNMghQ03LeZ3ZYxRABtY0X125ff7dXub5RNf/w
FdYpaYSkAADscgMgPZuZTeWdIh1bNg==
=+79V
-END PGP SIGNATURE-
___
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: Jails Documentation in FreeBSD handbook

2018-09-21 Thread Benedict Reuschling
Hello Martin,

no problem. Let us know if we can make any textual corrections that
might help understand things better.

Regards,
Benedict

Am 21.09.18 um 15:19 schrieb Martin Stiemerling:
> forget about thisone has to read better the text.
> 
> Am 21.09.18 um 14:14 schrieb Martin Stiemerling:
>> Hi there,
>>
>> I am just working through the documentation on how to install jails
>> and figured out (at least for me :) that one step is missing in the
>> handbook:
>>
>> https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/jails-build.html
>>
>>
>> It's required to have the FreeBSD src installed after this "The
>> jail(8) manual page explains the procedure for building a jail:".
>>
>> However, the steps above do not install the FreeBSD src when doing
>> this on  11.2-RELEASE-p3
>>
>> This is missing:
>> tar -xf /mnt/usr/freebsd-dist/src.txz -C $DESTDIR
>>
>> Thanks and kind regards,
>>
>>    Martin
> ___
> 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"
> 




signature.asc
Description: OpenPGP digital signature


Re: Possible patch for zfs-zpool.html

2018-10-25 Thread Benedict Reuschling
Hello Sine Astris,

Am 25.10.18 um 11:28 schrieb sine astris:
> Hi,
> 
> When upgrading zfs pool there is only an example for legacy boot
> systems, there doesn't seem to be an example for EFI systems in either
> the handbook, gpart(8), or zfs(8).
> 
> I've attached a small patch to zfs-zpool.html which amends the warning
> already given.
> 

Thank you for the addition to our documents. We usually don't edit the
HTML files as they are the output of our doc sources, which are in
DocBook XML. I'll work on getting your changes into the document.

If you want to know how to check out the sources, make changes to our
documents and submit a patch, take a look at this document:

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

Regards,
Benedict




signature.asc
Description: OpenPGP digital signature


Re: Options, devices, hints - Documentation work needed ?

2018-12-03 Thread Benedict Reuschling
Hello Dirk,

I think this is definitely valueable in multiple ways:

- finding missing entries in NOTES or lacking a man page (as you noted)
- adding cross references and notes to existing man pages (when appropriate)
- checking if all these options are needed or are included implicitly
during kernel builds
- identifying outdated information or obsolete entries

Cross references will help developers understanding how things are
interconnected within the kernel and the source tree.

I'm just wondering what kind of format would be appropriate for the
table. It could be a big table on the FreeBSD wiki, but it could also be
part of the developers handbook or a separate article. Can you send us
an excerpt so that we can see how it looks like? It does not have to be
fancy, just to get a feel for the information in it.

I could help out from the doc side of things and we should definitely
find someone from the kernel side to confirm that the findings make sense.

Thanks!

Cheers,
Benedict



Am 03.12.18 um 17:52 schrieb Dirk Schroetter:
> Hello there,
> 
> I am just working on my kernel and its config and after trying to find a 
> comprehensive list of kernel options, I came up short.
> 
> So I did fire up the editor and managed to get a python script running that 
> looks at:
> 
> * The ‚options‘ files under /usr/src
> * The ‚NOTES‘ files
> * The manual pages
> 
> all this being dumped into a table and cross-referenced.
> 
> My current stat on a FreeBSD 11.2 AMD64: Around 1000 kernel options of which 
> around half do not have either an entry in NOTES or are not mentioned on a 
> man page (e.g. ACPI_MAX_TAKS or ADA_TEST_FAILURE)
> 
> So I was going to try to compile some form of documentation for all of these 
> for my own personal use. Then I was wondering if the Documentation project 
> had any use for this kind of information. My idea was:
> 
> 1. Try to get the information into the respective NOTES files.
> 2. Make sure the options, devices, hints get into the option.h files
> 3. Updating the man pages.
> 
> It may be that this is a fool’s errand and much to big for a single person, 
> but I would volunteer to at least get it started, if you folks think that 
> there is any merit to it.
> 
> So that would be my proposal and I would love to hear back from you.
> 
> Best Regards,
> 
> /Dirk
> ___
> 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"
> 




signature.asc
Description: OpenPGP digital signature


Re: Willing to help with documentation

2018-12-17 Thread Benedict Reuschling


Am 17.12.18 um 05:47 schrieb Benjamin Kaduk:
> On Mon, Dec 17, 2018 at 01:55:07AM +0530, Nikolai Lvovich wrote:
>> Hi.
>>
>> I am new to the FreeBSD project (using since FreeBSD 11.1), and I use it as
>> only desktop OS during my university research, for frankly, I am amazed by
>> the quality and reliability of it, including the friendly handbook.
>>
>> However, I notice a few outdated info now and then in both
>>
>>
>>1. 1. FreeBSD handbook
>>2. 2. FreeBSD developer's handbook.
>>
>>
>> I am willing to help the project by updating the handbook. Please let me
>> know if you guys are interested in my request :)
> 
> Generally we are, with the caveat that getting volunteers to have the time
> to look at submissions can require persistence and manual pestering.
> You'll likely want to read
> https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/ and submit
> some bugzilla entries
> (https://bugs.freebsd.org/bugzilla/enter_bug.cgi?product=Documentation).
> Feel free to hop on to #bsddocs on efnet as well, whether for
> questions/discussion or to pester people to look at your patches.
> 
> -Ben

Hello Nikolai,

I'm glad to hear that you want to help out. Benjamin already covered a
good amount of starting points. If you have a list of things or even
just small bugs that need to be fixed, let us know. The "Quick Start"
section in the FDP primer should get you started:

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

If you have any questions or get stuck, let us know.

Regards,
Benedict



signature.asc
Description: OpenPGP digital signature


Re: Options, devices, hints - Documentation work needed ?

2018-12-20 Thread Benedict Reuschling
Hello Dirk,

sorry to keep you waiting.

The output looks interesting for further work. I think it would be great
for greater visibility (i.e., more eyes seeing it) to have it as a table
on the FreeBSD wiki. That way, we could mark each line of output with a
todo item, assign people to it, PRs or commits that adds the man page
reference, etc. During the process, we might discover that some items
don't warrant a man page (or even a reference) because they became
obsolete or are about to.

Do you have an account on the FreeBSD wiki yet to create and edit pages?
Would it be possible to modify your script to emit a wiki table which we
can then edit there?

Regards,
Benedict


Am 19.12.18 um 10:43 schrieb Dirk Schroetter:
> Hello Benedict,
> 
> I was wondering if you already had a chance to look over the output I sent a 
> few days back and maybe already have a view on how to use that to the. 
> Maximum benefit of the community.
> 
> Best Regards,
> 
> /Dirk
> 
>> Am 03.12.2018 um 18:57 schrieb Benedict Reuschling :
>>
>> Hello Dirk,
>>
>> I think this is definitely valueable in multiple ways:
>>
>> - finding missing entries in NOTES or lacking a man page (as you noted)
>> - adding cross references and notes to existing man pages (when appropriate)
>> - checking if all these options are needed or are included implicitly
>> during kernel builds
>> - identifying outdated information or obsolete entries
>>
>> Cross references will help developers understanding how things are
>> interconnected within the kernel and the source tree.
>>
>> I'm just wondering what kind of format would be appropriate for the
>> table. It could be a big table on the FreeBSD wiki, but it could also be
>> part of the developers handbook or a separate article. Can you send us
>> an excerpt so that we can see how it looks like? It does not have to be
>> fancy, just to get a feel for the information in it.
>>
>> I could help out from the doc side of things and we should definitely
>> find someone from the kernel side to confirm that the findings make sense.
>>
>> Thanks!
>>
>> Cheers,
>> Benedict
>>
>>
>>
>>> Am 03.12.18 um 17:52 schrieb Dirk Schroetter:
>>> Hello there,
>>>
>>> I am just working on my kernel and its config and after trying to find a 
>>> comprehensive list of kernel options, I came up short.
>>>
>>> So I did fire up the editor and managed to get a python script running that 
>>> looks at:
>>>
>>> * The ‚options‘ files under /usr/src
>>> * The ‚NOTES‘ files
>>> * The manual pages
>>>
>>> all this being dumped into a table and cross-referenced.
>>>
>>> My current stat on a FreeBSD 11.2 AMD64: Around 1000 kernel options of 
>>> which around half do not have either an entry in NOTES or are not mentioned 
>>> on a man page (e.g. ACPI_MAX_TAKS or ADA_TEST_FAILURE)
>>>
>>> So I was going to try to compile some form of documentation for all of 
>>> these for my own personal use. Then I was wondering if the Documentation 
>>> project had any use for this kind of information. My idea was:
>>>
>>> 1. Try to get the information into the respective NOTES files.
>>> 2. Make sure the options, devices, hints get into the option.h files
>>> 3. Updating the man pages.
>>>
>>> It may be that this is a fool’s errand and much to big for a single person, 
>>> but I would volunteer to at least get it started, if you folks think that 
>>> there is any merit to it.
>>>
>>> So that would be my proposal and I would love to hear back from you.
>>>
>>> Best Regards,
>>>
>>> /Dirk
>>> ___
>>> 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"
>>>
>>
>>
> 




signature.asc
Description: OpenPGP digital signature


Re: My Interest in participating translation projects

2019-03-12 Thread Benedict Reuschling
Hi,

thank you for wanting to help with translations. The FreeBSD Project
Primer [1] has all the information you are looking for to get started.
Begin with the "Quick Start" section [2] to set up your work
environment. Once you have that (if you get stuck somewhere along the
way, let us know), continue on to the "Translations" [3] and "PO
Translations" chapters.

I'd recommend starting with a small chapter so that you can see quick
results and don't get overwhelmed. There are also web tools that help
with the translation part of things that had some good results for other
language projects.

If you have further questions, get in touch and we'll try to help. You
can also find people on #bsddocs on IRC EFNet.

Regards,
Benedict



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


Am 11.03.19 um 19:56 schrieb Razeel Akbar:
> Hi,
> 
> I'd like to start the translation of documentation in my first language
> "Tamil", Please advise me the relevant guidelines and best practices that I
> should follow
> 
> Thank you
> 

-- 
Benedict Reuschling
Documentation Committer
The FreeBSD Project
The FreeBSD Documentation Project



signature.asc
Description: OpenPGP digital signature


Re: FreeBSD in Antarctida

2019-04-11 Thread Benedict Reuschling
Would you be interested in writing a blog post for the FreeBSD
Foundation or an article for the FreeBSD Journal?

You can also publish your own article and we link to it from the
FreeBSD.org website.

Regards,
Benedict

Am 11.04.19 um 06:50 schrieb Восток ШРМ:
> :)
> Good!
> FreeBSD forewer :)
> 
> -- Vostok. Antarctida.
> ___
> 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"
> 



signature.asc
Description: OpenPGP digital signature


Re: error in documentation

2019-04-19 Thread Benedict Reuschling
Hello,

thank you for reporting this bug to us. I've just committed a fix for
the handbook to address it.

Best regards,
Benedict Reuschling

Am 14.04.19 um 18:50 schrieb Laurent GILBERT:
> Dear Sirs,
> 
> I'm thinking I found a small mistake in the documentation
> "https://www.freebsd.org/doc/en/books/handbook/firewalls-ipfw.html";,
> "30.4.1. Enabling IPFW" :
> 
> "sysrc -f /etc/sysctl.conf net.inet.ip.fw.verbose_limit=5" doesn't work
> on FREEBSD 12 :
> 
> root@srv01:~ # sysrc -f /etc/sysctl.conf net.inet.ip.fw.verbose_limit= 5
> sysrc: net.inet.ip.fw.verbose_limit: name contains characters not
> allowed in shell
> 
> The character "." doesn't appear to be a legal char according to the the
> content of VALID_VARNAME_CHARS variable.
> 
> Best regards,
> 
> Laurent GILBERT.
> 
> 
> 
> SPIRALE INGÉNIERIE
> 
> Tél. : +33 (0)2 98 89 00 80
> 
> BP 29, Place Charles Minguy
> 
> 29217 LE CONQUET – FRANCE
> 
> 
> 
> PS : « @spirale-ingenierie.com » ó « @spiralhe.com »
> 
> 
> 
> ___
> 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"
> 



signature.asc
Description: OpenPGP digital signature


Re: Broken link in Handbook

2019-04-19 Thread Benedict Reuschling
Hello Ron,

sorry to keep you waiting.
I just committed a fix to the article.

Good luck with your FreeBSD efforts!

Have a nice day.

Benedict

Am 09.04.19 um 06:29 schrieb Ron Poutre:
> New to FreeBSD while going through the handbook i found a broken link just
> reporting it.
> 
> Have a nice day.
> 
> This page has a link below for gutenprint that is broken 404 error
> https://www.freebsd.org/doc/en_US.ISO8859-1/articles/cups/printing-cups-install.html
> 
> Broken link below
> https://www.freebsd.org/cgi/url.cgi?ports/print/gutenprint-cups/pkg-descr
> 



signature.asc
Description: OpenPGP digital signature


Re: Small correction on handbook page

2019-04-28 Thread Benedict Reuschling
Hello Dennis,

thank you for reporting this. I just committed a fix to the handbook.

Regards,
Benedict

Am 27.04.19 um 23:02 schrieb DL Gray:
> Hi
> 
> On this webpage
> https://www.freebsd.org/doc/handbook/virtualization-guest-virtualbox.html
> 
> at the bottom, there is a command to mount the share
> # mount_vboxfs -w *myshare* */mnt*
> 
> This is not correct, missing a "v" in the mount_vbox... command
> # mount_vboxvfs -w *myshare* */mnt*
> 
> I verified that the program exists in /usr/local/sbin
> 
> HTH
> Dennis
> ___
> 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"
> 



signature.asc
Description: OpenPGP digital signature


Re: Section 1.2.2 "Who Uses FreeBSD?" correction

2019-06-20 Thread Benedict Reuschling
Hello David,

thank you for letting us know about this. I will commit a change to the
handbook momentarily. It will then update the page once the build is
complete.

Best regards,
Benedict Reuschling

Am 20.06.19 um 02:37 schrieb David Holcomb (dholcomb):
> In section 1.2.2 of the FreeBSD Handbook 
> (https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/nutshell.html), I 
> would like to propose a correction.  The listing for “Dell KACE” needs to be 
> corrected to “Quest KACE” with the URL pointing to 
> https://www.quest.com/kace.  Today, the FreeBSD Foundation made a similar 
> correction on their page https://www.freebsdfoundation.org/freebsd/.
> 
> Back in October 2016, Dell decided to sell off the Dell Software Group to 
> venture capitalists wherein we became Quest Software with a separate Business 
> Unit encompassing the KACE product line.  On November 1, 2016 we became Quest 
> Software.  It would be great if you were to correct the attribution in the 
> handbook.
> 
> Thanks for keeping FreeBSD at the TOP (my opinion) of operating system 
> choices!
> 
> David Holcomb
> Software Development Principal Engineer
> Quest | KACE
> david.holc...@quest.com<mailto:david.holc...@quest.com>
> Office: +1 801-494-1495
> 
> 
> ___
> 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"
> 



signature.asc
Description: OpenPGP digital signature


Re: Need a reviewer for Russian translation patch

2019-07-02 Thread Benedict Reuschling


Am 02.07.19 um 16:20 schrieb Gleb Popov:
> On Tue, Jul 2, 2019 at 6:07 PM  wrote:
> 
>> On Tue, 2 Jul 2019, 18:02+0400, Gleb Popov wrote:
>>
>>> On Tue, Jul 2, 2019 at 5:15 PM  wrote:
>>>
>>>> On Tue, 2 Jul 2019, 12:30+0400, Gleb Popov wrote:
>>>>
>>>>> Hello, freebsd-doc@
>>>>>
>>>>> I need someone to review and commit this change [1] to Russian
>>>> translation
>>>>> of Handbook.
>>>>>
>>>>> Thanks in advance.
>>>>>
>>>>> [1] https://reviews.freebsd.org/D20832
>>>>
>>>> Talking about http://arrowd.name/doc.diff:
>>>>
>>>> indentation in the last chunk looks dubious for me.  Otherwise looks
>>>> good.
>>>>
>>>
>>> Thanks for the review. What's wrong with it, specifically?
>>>
>> + воспользуйтесь утилитой &man.chpass.1;.  Её необходимо
>> + запустить с правами суперпользователя и передать имя
>> пользователя,
>> + которому требуется изменить класс, в качестве
>> параметра.
>>
>> There are additional 4 spaces or tab in front of "запустить"?
>>
> 
> Right, I have 4 character tabs configured. With it, the indentation looks
> OK. What's correct tab setting for FreeBSD docs sources?
> 
> 

You can find that in the editor configuration section in the FDP primer:

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

Regards,
Benedict
-- 
Benedict Reuschling
Documentation Committer
The FreeBSD Project
The FreeBSD Documentation Project



signature.asc
Description: OpenPGP digital signature


Re: Google Season of Docs/WINE Handbook Chapter

2020-09-02 Thread Benedict Reuschling
Hello Aaron,

I'm glad that we have you writing the WINE chapter for us in this year's
Google Season of Docs. I look forward to working with you and the
community on bringing our WINE docs to a modern version of what's
possible with the software.

In the past, people have used WINE to either run games on FreeBSD that
are not available as a native port. Other uses include running business
applications on FreeBSD. It would be great if we could cover these if
possible. There may be some articles on the FreeBSD wiki or the Forums
about WINE where people have provided instructions on how to make these
work on FreeBSD. We can probably adapt some of that in your work,
provided they still work.

Happy writing...

Benedict

On 02.09.20 19:31, Aaron Peters wrote:
> Hello FreeBSD docs peoples!
> 
> My name is Aaron, and I wanted to drop a note to introduce myself. I'll be
> working through the Google Season of Docs program. I'm a relative newbie to
> FreeBSD, so I'm looking forward to digging in.
> 
> My task for this year is a Handbook Chapter on WINE. So I wanted to put out
> a call for requests for anything you'd like to see included, something you
> found interesting/useful in the past, troubleshooting tips/tricks that can
> be written up and included. If you have any such suggestions, by all means
> send them my way.
> 
> Thanks, and look forward to working with everyone!
> 
> Aaron
> ___
> 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"