Re: svn commit: r314473 - head

2017-03-03 Thread Alexey Dokuchaev 
On Wed, Mar 01, 2017 at 08:29:57AM -0800, Rodney W. Grimes wrote:
> ...
> There are 21 directors in /usr/src, 20 of them documented in README,
> 18 of them documented in hier(7).
> 
> I'll rectifiy this if and when I get my commit bit.

Looks like you've just been punished.  Congratulations! ;-)

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

Re: svn commit: r314473 - head

2017-03-01 Thread Warner Losh 
On Wed, Mar 1, 2017 at 9:29 AM, Rodney W. Grimes
 wrote:
> I'll rectifiy this if and when I get my commit bit.

In the mean time, you could submit a Bugzilla or a github pull request :)

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

Re: svn commit: r314473 - head

2017-03-01 Thread Rodney W. Grimes 
> On Wed, Mar 1, 2017 at 9:04 AM, Rodney W. Grimes
>  wrote:
> >> On Tue, Feb 28, 2017 at 10:45 PM, Rodney W. Grimes
> >>  wrote:
> >> >> Author: imp
> >> >> Date: Wed Mar  1 05:05:05 2017
> >> >> New Revision: 314473
> >> >> URL: https://svnweb.freebsd.org/changeset/base/314473
> >> >>
> >> >> Log:
> >> >>   Create README.md file for viewing on github.
> >> >>
> >> >>   This is a lightly edited README using github's MARKDOWN.
> >> >>
> >> >>   Submitted by:   Johan 
> >> >>   Pull Request:   https://github.com/freebsd/freebsd/pull/56
> >> >>
> >> >> Added:
> >> >>   head/README.md   (contents, props changed)
> >> >>
> >> >> Added: head/README.md
> >> >> ==
> >> >> --- /dev/null 00:00:00 1970   (empty, because file is newly added)
> >> >> +++ head/README.mdWed Mar  1 05:05:05 2017(r314473)
> >> >> @@ -0,0 +1,86 @@
> >> >> +FreeBSD Source:
> >> >> +---
> >> >> +This is the top level of the FreeBSD source directory.  This file
> >> >> +was last revised on:
> >> >> +$FreeBSD$
> >> >> +
> >> >> +For copyright information, please see the file COPYRIGHT in this
> >> >> +directory (additional copyright information also exists for some
> >> >> +sources in this tree - please see the specific source directories for
> >> >> +more information).
> >> >> +
> >> >> +The Makefile in this directory supports a number of targets for
> >> >> +building components (or all) of the FreeBSD source tree.  See build(7)
> >> >> +and 
> >> >> http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
> >> >> +for more information, including setting make(1) variables.
> >> >> +
> >> >> +The `buildkernel` and `installkernel` targets build and install
> >> >> +the kernel and the modules (see below).  Please see the top of
> >> >> +the Makefile in this directory for more information on the
> >> >> +standard build targets and compile-time flags.
> >> >> +
> >> >> +Building a kernel is a somewhat more involved process.  See build(7), 
> >> >> config(8),
> >> >> +and 
> >> >> http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
> >> >> +for more information.
> >> >> +
> >> >> +Note: If you want to build and install the kernel with the
> >> >> +`buildkernel` and `installkernel` targets, you might need to build
> >> >> +world before.  More information is available in the handbook.
> >> >> +
> >> >> +The kernel configuration files reside in the `sys//conf`
> >> >> +sub-directory.  GENERIC is the default configuration used in release 
> >> >> builds.
> >> >> +NOTES contains entries and documentation for all possible
> >> >> +devices, not just those commonly used.
> >> >> +
> >> >> +
> >> >> +Source Roadmap:
> >> >> +---
> >> >
> >> > Is there someway this can be a pointer to the usr/src part of
> >> > hier(7) and have hier(7) updated to reflect current reality?
> >> >
> >> > Also lots and lots of trailing white space...
> >> >
> >> > This should be a pointer to hier(7)
> >>
> >> It's a verbatim copy of README converted to markdown. Maybe README
> >> should be fixed and this regenerated.
> >
> > Yes, but then couldnt this be a pointer to readme?  We have this
> > documented now in 3 places that are gona just get further out
> > of sync.  Or at least add a note to README that says you need
> > to update README.md if you touch this file.
> 
> README changes about once every other year. Not worth the churn.

And exactly what makes it a bad idea to have the same infromation
stored in 2, now 3 different places.  With no pointers to the
duplicated data for a human to follow it almost makes it certain
that things well diverge.

> >> The trailing whitespace is part
> >> of the conversion and not a mistake.
> >
> > I have learned this now and responded else where.  It appears
> > that there are ways to do this in markdown without using
> > trailing double spaces as a syntax item.
> >
> >> If you want to update README and hier(7) and have README.md generated
> >> from that automatically, be my guest. None of that was in the
> >> submission, and the submission was useful as it was.
> >
> > I agree that the submission is useful, as the README.md file,
> > just would like to see some polish put on it so it doesnt
> > suffer the same bitrot that hier(7) has.
> 
> I can't see what polish we could put here that would prevent that. If
> heir(7) is so horrible, fix it. Looking at it now shows just a tiny
> bit of rot in /usr/include and maybe /usr/share/doc.

There are 21 directors in /usr/src, 20 of them documented in README,
18 of them documented in hier(7).

I'll rectifiy this if and when I get my commit bit.

-- 
Rod Grimes rgri...@freebsd.org
___
svn-src-head@freebsd.org mailing list

Re: svn commit: r314473 - head

2017-03-01 Thread Rodney W. Grimes 
[ Charset UTF-8 unsupported, converting... ]
> On 1 March 2017 at 09:58, Warner Losh  wrote:
> >
> > It's a verbatim copy of README converted to markdown. Maybe README
> > should be fixed and this regenerated. The trailing whitespace is part
> > of the conversion and not a mistake.
> 
> I think the whitespace is a mistake, since the markdown version is
> rendered in variable width with proportional font, so hard 80-col
> wrapping is undesirable. I've removed the whitespace in r314495.

Thank you Ed, this makes much more sense for me too.
 
> > If you want to update README and hier(7) and have README.md generated
> > from that automatically, be my guest. None of that was in the
> > submission, and the submission was useful as it was.
> 
> I'm happy for us to have a README.md although we now have the issue of
> keeping them in sync (if we want to).

I have no objection what so ever to the README.md file.

> There are some minor things that we don't want to make completely
> identical -- for example, the rendered version claims "This file was
> last revised on: $FreeBSD$" because the svn-git exporter does not
> expand $FreeBSD$. I think we ought to just remove that sentence from
> the markdown version.

What about a From: line using the $FreeBSD$ of README?  At least
that might give some a notion that they should change README if
they find something wrong in README.md?

> Perhaps this suggests we don't try to keep them in sync, which is
> likely fine as they'll generally be seen by different groups of people
> (markdown for those browsing the project on GitHub, plain README for
> those with an installed source tree).

I would think 2 files with the same basename of README being used
by 2 different groups for the same purpose, a map of the src, should
be syncronized some how. 

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

Re: svn commit: r314473 - head

2017-03-01 Thread Warner Losh 
On Wed, Mar 1, 2017 at 9:04 AM, Rodney W. Grimes
 wrote:
>> On Tue, Feb 28, 2017 at 10:45 PM, Rodney W. Grimes
>>  wrote:
>> >> Author: imp
>> >> Date: Wed Mar  1 05:05:05 2017
>> >> New Revision: 314473
>> >> URL: https://svnweb.freebsd.org/changeset/base/314473
>> >>
>> >> Log:
>> >>   Create README.md file for viewing on github.
>> >>
>> >>   This is a lightly edited README using github's MARKDOWN.
>> >>
>> >>   Submitted by:   Johan 
>> >>   Pull Request:   https://github.com/freebsd/freebsd/pull/56
>> >>
>> >> Added:
>> >>   head/README.md   (contents, props changed)
>> >>
>> >> Added: head/README.md
>> >> ==
>> >> --- /dev/null 00:00:00 1970   (empty, because file is newly added)
>> >> +++ head/README.mdWed Mar  1 05:05:05 2017(r314473)
>> >> @@ -0,0 +1,86 @@
>> >> +FreeBSD Source:
>> >> +---
>> >> +This is the top level of the FreeBSD source directory.  This file
>> >> +was last revised on:
>> >> +$FreeBSD$
>> >> +
>> >> +For copyright information, please see the file COPYRIGHT in this
>> >> +directory (additional copyright information also exists for some
>> >> +sources in this tree - please see the specific source directories for
>> >> +more information).
>> >> +
>> >> +The Makefile in this directory supports a number of targets for
>> >> +building components (or all) of the FreeBSD source tree.  See build(7)
>> >> +and 
>> >> http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
>> >> +for more information, including setting make(1) variables.
>> >> +
>> >> +The `buildkernel` and `installkernel` targets build and install
>> >> +the kernel and the modules (see below).  Please see the top of
>> >> +the Makefile in this directory for more information on the
>> >> +standard build targets and compile-time flags.
>> >> +
>> >> +Building a kernel is a somewhat more involved process.  See build(7), 
>> >> config(8),
>> >> +and 
>> >> http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
>> >> +for more information.
>> >> +
>> >> +Note: If you want to build and install the kernel with the
>> >> +`buildkernel` and `installkernel` targets, you might need to build
>> >> +world before.  More information is available in the handbook.
>> >> +
>> >> +The kernel configuration files reside in the `sys//conf`
>> >> +sub-directory.  GENERIC is the default configuration used in release 
>> >> builds.
>> >> +NOTES contains entries and documentation for all possible
>> >> +devices, not just those commonly used.
>> >> +
>> >> +
>> >> +Source Roadmap:
>> >> +---
>> >
>> > Is there someway this can be a pointer to the usr/src part of
>> > hier(7) and have hier(7) updated to reflect current reality?
>> >
>> > Also lots and lots of trailing white space...
>> >
>> > This should be a pointer to hier(7)
>>
>> It's a verbatim copy of README converted to markdown. Maybe README
>> should be fixed and this regenerated.
>
> Yes, but then couldnt this be a pointer to readme?  We have this
> documented now in 3 places that are gona just get further out
> of sync.  Or at least add a note to README that says you need
> to update README.md if you touch this file.

README changes about once every other year. Not worth the churn.

>> The trailing whitespace is part
>> of the conversion and not a mistake.
>
> I have learned this now and responded else where.  It appears
> that there are ways to do this in markdown without using
> trailing double spaces as a syntax item.
>
>> If you want to update README and hier(7) and have README.md generated
>> from that automatically, be my guest. None of that was in the
>> submission, and the submission was useful as it was.
>
> I agree that the submission is useful, as the README.md file,
> just would like to see some polish put on it so it doesnt
> suffer the same bitrot that hier(7) has.

I can't see what polish we could put here that would prevent that. If
heir(7) is so horrible, fix it. Looking at it now shows just a tiny
bit of rot in /usr/include and maybe /usr/share/doc.

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

Re: svn commit: r314473 - head

2017-03-01 Thread Rodney W. Grimes 
> On Tue, Feb 28, 2017 at 10:45 PM, Rodney W. Grimes
>  wrote:
> >> Author: imp
> >> Date: Wed Mar  1 05:05:05 2017
> >> New Revision: 314473
> >> URL: https://svnweb.freebsd.org/changeset/base/314473
> >>
> >> Log:
> >>   Create README.md file for viewing on github.
> >>
> >>   This is a lightly edited README using github's MARKDOWN.
> >>
> >>   Submitted by:   Johan 
> >>   Pull Request:   https://github.com/freebsd/freebsd/pull/56
> >>
> >> Added:
> >>   head/README.md   (contents, props changed)
> >>
> >> Added: head/README.md
> >> ==
> >> --- /dev/null 00:00:00 1970   (empty, because file is newly added)
> >> +++ head/README.mdWed Mar  1 05:05:05 2017(r314473)
> >> @@ -0,0 +1,86 @@
> >> +FreeBSD Source:
> >> +---
> >> +This is the top level of the FreeBSD source directory.  This file
> >> +was last revised on:
> >> +$FreeBSD$
> >> +
> >> +For copyright information, please see the file COPYRIGHT in this
> >> +directory (additional copyright information also exists for some
> >> +sources in this tree - please see the specific source directories for
> >> +more information).
> >> +
> >> +The Makefile in this directory supports a number of targets for
> >> +building components (or all) of the FreeBSD source tree.  See build(7)
> >> +and 
> >> http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
> >> +for more information, including setting make(1) variables.
> >> +
> >> +The `buildkernel` and `installkernel` targets build and install
> >> +the kernel and the modules (see below).  Please see the top of
> >> +the Makefile in this directory for more information on the
> >> +standard build targets and compile-time flags.
> >> +
> >> +Building a kernel is a somewhat more involved process.  See build(7), 
> >> config(8),
> >> +and 
> >> http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
> >> +for more information.
> >> +
> >> +Note: If you want to build and install the kernel with the
> >> +`buildkernel` and `installkernel` targets, you might need to build
> >> +world before.  More information is available in the handbook.
> >> +
> >> +The kernel configuration files reside in the `sys//conf`
> >> +sub-directory.  GENERIC is the default configuration used in release 
> >> builds.
> >> +NOTES contains entries and documentation for all possible
> >> +devices, not just those commonly used.
> >> +
> >> +
> >> +Source Roadmap:
> >> +---
> >
> > Is there someway this can be a pointer to the usr/src part of
> > hier(7) and have hier(7) updated to reflect current reality?
> >
> > Also lots and lots of trailing white space...
> >
> > This should be a pointer to hier(7)
> 
> It's a verbatim copy of README converted to markdown. Maybe README
> should be fixed and this regenerated.

Yes, but then couldnt this be a pointer to readme?  We have this
documented now in 3 places that are gona just get further out
of sync.  Or at least add a note to README that says you need
to update README.md if you touch this file.

> The trailing whitespace is part
> of the conversion and not a mistake.

I have learned this now and responded else where.  It appears
that there are ways to do this in markdown without using
trailing double spaces as a syntax item.

> If you want to update README and hier(7) and have README.md generated
> from that automatically, be my guest. None of that was in the
> submission, and the submission was useful as it was.

I agree that the submission is useful, as the README.md file,
just would like to see some polish put on it so it doesnt
suffer the same bitrot that hier(7) has.


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

Re: svn commit: r314473 - head

2017-03-01 Thread Ed Maste 
On 1 March 2017 at 09:58, Warner Losh  wrote:
>
> It's a verbatim copy of README converted to markdown. Maybe README
> should be fixed and this regenerated. The trailing whitespace is part
> of the conversion and not a mistake.

I think the whitespace is a mistake, since the markdown version is
rendered in variable width with proportional font, so hard 80-col
wrapping is undesirable. I've removed the whitespace in r314495.

> If you want to update README and hier(7) and have README.md generated
> from that automatically, be my guest. None of that was in the
> submission, and the submission was useful as it was.

I'm happy for us to have a README.md although we now have the issue of
keeping them in sync (if we want to).

There are some minor things that we don't want to make completely
identical -- for example, the rendered version claims "This file was
last revised on: $FreeBSD$" because the svn-git exporter does not
expand $FreeBSD$. I think we ought to just remove that sentence from
the markdown version.

Perhaps this suggests we don't try to keep them in sync, which is
likely fine as they'll generally be seen by different groups of people
(markdown for those browsing the project on GitHub, plain README for
those with an installed source tree).
___
svn-src-head@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/svn-src-head
To unsubscribe, send any mail to "svn-src-head-unsubscr...@freebsd.org"

Re: svn commit: r314473 - head

2017-03-01 Thread Warner Losh 
On Wed, Mar 1, 2017 at 8:49 AM, Rodney W. Grimes
 wrote:
> [ Charset UTF-8 unsupported, converting... ]
>>
>>
>> Am 1. M?rz 2017 06:45:25 MEZ schrieb "Rodney W. Grimes" 
>> :
>> >> Author: imp
>> >> Date: Wed Mar  1 05:05:05 2017
>> >> New Revision: 314473
>> >> URL: https://svnweb.freebsd.org/changeset/base/314473
>> >>
>> >> Log:
>> >>   Create README.md file for viewing on github.
>> >>
>> >>   This is a lightly edited README using github's MARKDOWN.
>> >>
>> >>   Submitted by:Johan 
>> >>   Pull Request:https://github.com/freebsd/freebsd/pull/56
>> >>
>> >> Added:
>> >>   head/README.md   (contents, props changed)
>> >> [?]
>> > [?]
>> >Also lots and lots of trailing white space...
>> >
>> >[?]
>>
>> Trailing whitespace can be significant in
>> markdown: Two trailing spaces force a
>> linebreak in the rendered output.
>
> You have to be kidding me?  Anything that treats white space as
> a significant part of the syntax is... well.. broken by design.
>
> Yes, including phython.
>
> A quick google yeilds me this about github markdown:
> (Technical note: Markdown Here uses GFM line breaks, so
> there's no need to use MD's two-space line breaks.)
>
> And wordpress's use of markdown also has abaondon this.
>
> I would say lets please abaondon it as a bad idea as it
> appears as if git/github can use something called GFM?

Knock yourself out if you want to do something better, or get someone
else (not me) to do something better. Ed's already made things look a
bit better, so if you can improve on that work great.

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

Re: svn commit: r314473 - head

2017-03-01 Thread Rodney W. Grimes 
[ Charset UTF-8 unsupported, converting... ]
> 
> 
> Am 1. M?rz 2017 06:45:25 MEZ schrieb "Rodney W. Grimes" 
> :
> >> Author: imp
> >> Date: Wed Mar  1 05:05:05 2017
> >> New Revision: 314473
> >> URL: https://svnweb.freebsd.org/changeset/base/314473
> >> 
> >> Log:
> >>   Create README.md file for viewing on github.
> >>   
> >>   This is a lightly edited README using github's MARKDOWN.
> >>   
> >>   Submitted by:Johan 
> >>   Pull Request:https://github.com/freebsd/freebsd/pull/56
> >> 
> >> Added:
> >>   head/README.md   (contents, props changed)
> >> [?]
> > [?]
> >Also lots and lots of trailing white space...
> >
> >[?]
> 
> Trailing whitespace can be significant in
> markdown: Two trailing spaces force a 
> linebreak in the rendered output. 

You have to be kidding me?  Anything that treats white space as
a significant part of the syntax is... well.. broken by design.

Yes, including phython.

A quick google yeilds me this about github markdown:
(Technical note: Markdown Here uses GFM line breaks, so
there's no need to use MD's two-space line breaks.)

And wordpress's use of markdown also has abaondon this.

I would say lets please abaondon it as a bad idea as it
appears as if git/github can use something called GFM?

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

Re: svn commit: r314473 - head

2017-03-01 Thread Warner Losh 
On Tue, Feb 28, 2017 at 10:45 PM, Rodney W. Grimes
 wrote:
>> Author: imp
>> Date: Wed Mar  1 05:05:05 2017
>> New Revision: 314473
>> URL: https://svnweb.freebsd.org/changeset/base/314473
>>
>> Log:
>>   Create README.md file for viewing on github.
>>
>>   This is a lightly edited README using github's MARKDOWN.
>>
>>   Submitted by:   Johan 
>>   Pull Request:   https://github.com/freebsd/freebsd/pull/56
>>
>> Added:
>>   head/README.md   (contents, props changed)
>>
>> Added: head/README.md
>> ==
>> --- /dev/null 00:00:00 1970   (empty, because file is newly added)
>> +++ head/README.mdWed Mar  1 05:05:05 2017(r314473)
>> @@ -0,0 +1,86 @@
>> +FreeBSD Source:
>> +---
>> +This is the top level of the FreeBSD source directory.  This file
>> +was last revised on:
>> +$FreeBSD$
>> +
>> +For copyright information, please see the file COPYRIGHT in this
>> +directory (additional copyright information also exists for some
>> +sources in this tree - please see the specific source directories for
>> +more information).
>> +
>> +The Makefile in this directory supports a number of targets for
>> +building components (or all) of the FreeBSD source tree.  See build(7)
>> +and http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
>> +for more information, including setting make(1) variables.
>> +
>> +The `buildkernel` and `installkernel` targets build and install
>> +the kernel and the modules (see below).  Please see the top of
>> +the Makefile in this directory for more information on the
>> +standard build targets and compile-time flags.
>> +
>> +Building a kernel is a somewhat more involved process.  See build(7), 
>> config(8),
>> +and 
>> http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
>> +for more information.
>> +
>> +Note: If you want to build and install the kernel with the
>> +`buildkernel` and `installkernel` targets, you might need to build
>> +world before.  More information is available in the handbook.
>> +
>> +The kernel configuration files reside in the `sys//conf`
>> +sub-directory.  GENERIC is the default configuration used in release builds.
>> +NOTES contains entries and documentation for all possible
>> +devices, not just those commonly used.
>> +
>> +
>> +Source Roadmap:
>> +---
>
> Is there someway this can be a pointer to the usr/src part of
> hier(7) and have hier(7) updated to reflect current reality?
>
> Also lots and lots of trailing white space...
>
> This should be a pointer to hier(7)

It's a verbatim copy of README converted to markdown. Maybe README
should be fixed and this regenerated. The trailing whitespace is part
of the conversion and not a mistake.

If you want to update README and hier(7) and have README.md generated
from that automatically, be my guest. None of that was in the
submission, and the submission was useful as it was.

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

Re: svn commit: r314473 - head

2017-03-01 Thread Florian Ermisch 


Am 1. März 2017 06:45:25 MEZ schrieb "Rodney W. Grimes" 
:
>> Author: imp
>> Date: Wed Mar  1 05:05:05 2017
>> New Revision: 314473
>> URL: https://svnweb.freebsd.org/changeset/base/314473
>> 
>> Log:
>>   Create README.md file for viewing on github.
>>   
>>   This is a lightly edited README using github's MARKDOWN.
>>   
>>   Submitted by:  Johan 
>>   Pull Request:  https://github.com/freebsd/freebsd/pull/56
>> 
>> Added:
>>   head/README.md   (contents, props changed)
>> […]
> […]
>Also lots and lots of trailing white space...
>
>[…]

Trailing whitespace can be significant in
markdown: Two trailing spaces force a 
linebreak in the rendered output. 

Regards, Florian 
___
svn-src-head@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/svn-src-head
To unsubscribe, send any mail to "svn-src-head-unsubscr...@freebsd.org"

Re: svn commit: r314473 - head

2017-02-28 Thread Rodney W. Grimes 
> Author: imp
> Date: Wed Mar  1 05:05:05 2017
> New Revision: 314473
> URL: https://svnweb.freebsd.org/changeset/base/314473
> 
> Log:
>   Create README.md file for viewing on github.
>   
>   This is a lightly edited README using github's MARKDOWN.
>   
>   Submitted by:   Johan 
>   Pull Request:   https://github.com/freebsd/freebsd/pull/56
> 
> Added:
>   head/README.md   (contents, props changed)
> 
> Added: head/README.md
> ==
> --- /dev/null 00:00:00 1970   (empty, because file is newly added)
> +++ head/README.mdWed Mar  1 05:05:05 2017(r314473)
> @@ -0,0 +1,86 @@
> +FreeBSD Source:
> +---
> +This is the top level of the FreeBSD source directory.  This file  
> +was last revised on:  
> +$FreeBSD$
> +
> +For copyright information, please see the file COPYRIGHT in this  
> +directory (additional copyright information also exists for some
> +sources in this tree - please see the specific source directories for  
> +more information).
> +
> +The Makefile in this directory supports a number of targets for  
> +building components (or all) of the FreeBSD source tree.  See build(7)  
> +and http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html 
>  
> +for more information, including setting make(1) variables.  
> +
> +The `buildkernel` and `installkernel` targets build and install  
> +the kernel and the modules (see below).  Please see the top of  
> +the Makefile in this directory for more information on the  
> +standard build targets and compile-time flags.
> +
> +Building a kernel is a somewhat more involved process.  See build(7), 
> config(8),  
> +and 
> http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html  
> +for more information.
> +
> +Note: If you want to build and install the kernel with the  
> +`buildkernel` and `installkernel` targets, you might need to build  
> +world before.  More information is available in the handbook.
> +
> +The kernel configuration files reside in the `sys//conf`  
> +sub-directory.  GENERIC is the default configuration used in release builds. 
>  
> +NOTES contains entries and documentation for all possible  
> +devices, not just those commonly used.
> +
> +
> +Source Roadmap:
> +---

Is there someway this can be a pointer to the usr/src part of
hier(7) and have hier(7) updated to reflect current reality?

Also lots and lots of trailing white space...

This should be a pointer to hier(7)

> +```
> +bin  System/user commands.
> +
> +cddl Various commands and libraries under the Common 
> Development  
> + and Distribution License.
> +
> +contrib  Packages contributed by 3rd parties.
> +
> +crypto   Cryptography stuff (see crypto/README).
> +
> +etc  Template files for /etc.
> +
> +gnu  Various commands and libraries under the GNU 
> Public License.  
> + Please see gnu/COPYING* for more information.
> +
> +include  System include files.
> +
> +kerberos5Kerberos5 (Heimdal) package.
> +
> +lib  System libraries.
> +
> +libexec  System daemons.
> +
> +release  Release building Makefile & associated tools.
> +
> +rescue   Build system for statically linked /rescue 
> utilities.
> +
> +sbin System commands.
> +
> +secure   Cryptographic libraries and commands.
> +
> +shareShared resources.
> +
> +sys  Kernel sources.
> +
> +testsRegression tests which can be run by Kyua.  See 
> tests/README
> + for additional information.
> +
> +toolsUtilities for regression testing and 
> miscellaneous tasks.
> +
> +usr.bin  User commands.
> +
> +usr.sbin System administration commands.
> +```
> +
> +For information on synchronizing your source tree with one or more of  
> +the FreeBSD Project's development branches, please see:
> +
> +   http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/synching.html
> ___
> svn-src-head@freebsd.org mailing list
> https://lists.freebsd.org/mailman/listinfo/svn-src-head
> To unsubscribe, send any mail to "svn-src-head-unsubscr...@freebsd.org"
> 

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

Re: svn commit: r314473 - head

2017-02-28 Thread Warner Losh 
On Tue, Feb 28, 2017 at 10:13 PM, Ngie Cooper (yaneurabeya)
 wrote:
>
>> On Feb 28, 2017, at 21:05, Warner Losh  wrote:
>>
>> Author: imp
>> Date: Wed Mar  1 05:05:05 2017
>> New Revision: 314473
>> URL: https://svnweb.freebsd.org/changeset/base/314473
>>
>> Log:
>>  Create README.md file for viewing on github.
>>
>>  This is a lightly edited README using github's MARKDOWN.
>>
>>  Submitted by:Johan 
>>  Pull Request:https://github.com/freebsd/freebsd/pull/56
>
> Cool! Would it make sense to refer to the other file? Also, this 
> might make it a bit interesting for projects that fork FreeBSD and hack on it 
> when doing future merges, but that’s a caveat that those projects will have 
> to deal with when the time comes to merge this in.

Don't know what's best... That's a good question. I'm inclined to
leave it alone for now...

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

Re: svn commit: r314473 - head

2017-02-28 Thread Ngie Cooper (yaneurabeya) 

> On Feb 28, 2017, at 21:05, Warner Losh  wrote:
> 
> Author: imp
> Date: Wed Mar  1 05:05:05 2017
> New Revision: 314473
> URL: https://svnweb.freebsd.org/changeset/base/314473
> 
> Log:
>  Create README.md file for viewing on github.
> 
>  This is a lightly edited README using github's MARKDOWN.
> 
>  Submitted by:Johan 
>  Pull Request:https://github.com/freebsd/freebsd/pull/56

Cool! Would it make sense to refer to the other file? Also, this might 
make it a bit interesting for projects that fork FreeBSD and hack on it when 
doing future merges, but that’s a caveat that those projects will have to deal 
with when the time comes to merge this in.
Thanks!
-Ngie


signature.asc
Description: Message signed with OpenPGP using GPGMail

svn commit: r314473 - head

2017-02-28 Thread Warner Losh 
Author: imp
Date: Wed Mar  1 05:05:05 2017
New Revision: 314473
URL: https://svnweb.freebsd.org/changeset/base/314473

Log:
  Create README.md file for viewing on github.
  
  This is a lightly edited README using github's MARKDOWN.
  
  Submitted by: Johan 
  Pull Request: https://github.com/freebsd/freebsd/pull/56

Added:
  head/README.md   (contents, props changed)

Added: head/README.md
==
--- /dev/null   00:00:00 1970   (empty, because file is newly added)
+++ head/README.md  Wed Mar  1 05:05:05 2017(r314473)
@@ -0,0 +1,86 @@
+FreeBSD Source:
+---
+This is the top level of the FreeBSD source directory.  This file  
+was last revised on:  
+$FreeBSD$
+
+For copyright information, please see the file COPYRIGHT in this  
+directory (additional copyright information also exists for some
+sources in this tree - please see the specific source directories for  
+more information).
+
+The Makefile in this directory supports a number of targets for  
+building components (or all) of the FreeBSD source tree.  See build(7)  
+and http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html  
+for more information, including setting make(1) variables.  
+
+The `buildkernel` and `installkernel` targets build and install  
+the kernel and the modules (see below).  Please see the top of  
+the Makefile in this directory for more information on the  
+standard build targets and compile-time flags.
+
+Building a kernel is a somewhat more involved process.  See build(7), 
config(8),  
+and 
http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html  
+for more information.
+
+Note: If you want to build and install the kernel with the  
+`buildkernel` and `installkernel` targets, you might need to build  
+world before.  More information is available in the handbook.
+
+The kernel configuration files reside in the `sys//conf`  
+sub-directory.  GENERIC is the default configuration used in release builds.  
+NOTES contains entries and documentation for all possible  
+devices, not just those commonly used.
+
+
+Source Roadmap:
+---
+```
+binSystem/user commands.
+
+cddl   Various commands and libraries under the Common 
Development  
+   and Distribution License.
+
+contribPackages contributed by 3rd parties.
+
+crypto Cryptography stuff (see crypto/README).
+
+etcTemplate files for /etc.
+
+gnuVarious commands and libraries under the GNU 
Public License.  
+   Please see gnu/COPYING* for more information.
+
+includeSystem include files.
+
+kerberos5  Kerberos5 (Heimdal) package.
+
+libSystem libraries.
+
+libexecSystem daemons.
+
+releaseRelease building Makefile & associated tools.
+
+rescue Build system for statically linked /rescue utilities.
+
+sbin   System commands.
+
+secure Cryptographic libraries and commands.
+
+share  Shared resources.
+
+sysKernel sources.
+
+tests  Regression tests which can be run by Kyua.  See 
tests/README
+   for additional information.
+
+tools  Utilities for regression testing and miscellaneous 
tasks.
+
+usr.binUser commands.
+
+usr.sbin   System administration commands.
+```
+
+For information on synchronizing your source tree with one or more of  
+the FreeBSD Project's development branches, please see:
+
+   http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/synching.html
___
svn-src-head@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/svn-src-head
To unsubscribe, send any mail to "svn-src-head-unsubscr...@freebsd.org"