Re: svn commit: r334073 - head

[Eitan Adler]

On 23 May 2018 at 15:48, John Baldwin  wrote:
> On Wednesday, May 23, 2018 12:09:59 PM Eitan Adler wrote:
>> On 23 May 2018 at 09:27, John Baldwin  wrote:
>> > On Wednesday, May 23, 2018 04:09:01 AM Eitan Adler wrote:
>> >> Author: eadler
>> >> Date: Wed May 23 04:09:01 2018
>> >> New Revision: 334073
>> >> URL: https://svnweb.freebsd.org/changeset/base/334073
>> >>
>> >> Log:
>> >>   README: Reduce the textdump; describe the project
>> >>
>> >>   Rework the README to make it a little easier for new users. This is the
>> >>   first file many will see when persuing the FreeBSD source code so
>> >>
>> >>   - remove some of the text describes how to build. This is better covered
>> >>   in the linked documentation.
>> >>   - add a small blurb for what FreeBSD is. Some users might find this
>> >>   document through features such as github search so they may not even
>> >>   know what the project is
>> >>
>> >>   generally, gear this file for the new, accidental, or casual user rather
>> >>   than towards someone seeking fuller documentation.
>> >>
>> >> Modified:
>> >>   head/README
>> >>   head/README.md
>> >>
>> >> Modified: head/README
>> >> ==
>> >> --- head/README   Wed May 23 03:41:22 2018(r334072)
>> >> +++ head/README   Wed May 23 04:09:01 2018(r334073)
>> >> @@ -2,35 +2,25 @@ This is the top level of the FreeBSD source directory.
>> >> -
>> >> -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.
>> >
>> > I do think this paragraph is still useful as part of the Source Roadmap and
>> > not really part of the build instructions.
>>
>> I added a reference to sys//conf to the bottom of the
>> README.Adding something about NOTES might be helpful, but IMHO closer
>> to the build.
>
> Yes, but the directory doesn't tell you which file is the default kernel.
> I'm thinking in terms of a random person browsing the tree via github's web
> interface who doesn't know which files are which in which case I think this
> note was kind of useful.

SendingREADME
SendingREADME.md
Transmitting file data ..done
Committing transaction...
Committed revision 335299.



-- 
Eitan Adler
Source, Ports, Doc committer
Bugmeister, Ports Security teams
___
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: r334073 - head

[John Baldwin]

On Wednesday, May 23, 2018 12:09:59 PM Eitan Adler wrote:
> On 23 May 2018 at 09:27, John Baldwin  wrote:
> > On Wednesday, May 23, 2018 04:09:01 AM Eitan Adler wrote:
> >> Author: eadler
> >> Date: Wed May 23 04:09:01 2018
> >> New Revision: 334073
> >> URL: https://svnweb.freebsd.org/changeset/base/334073
> >>
> >> Log:
> >>   README: Reduce the textdump; describe the project
> >>
> >>   Rework the README to make it a little easier for new users. This is the
> >>   first file many will see when persuing the FreeBSD source code so
> >>
> >>   - remove some of the text describes how to build. This is better covered
> >>   in the linked documentation.
> >>   - add a small blurb for what FreeBSD is. Some users might find this
> >>   document through features such as github search so they may not even
> >>   know what the project is
> >>
> >>   generally, gear this file for the new, accidental, or casual user rather
> >>   than towards someone seeking fuller documentation.
> >>
> >> Modified:
> >>   head/README
> >>   head/README.md
> >>
> >> Modified: head/README
> >> ==
> >> --- head/README   Wed May 23 03:41:22 2018(r334072)
> >> +++ head/README   Wed May 23 04:09:01 2018(r334073)
> >> @@ -2,35 +2,25 @@ This is the top level of the FreeBSD source directory.
> >> -
> >> -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.
> >
> > I do think this paragraph is still useful as part of the Source Roadmap and
> > not really part of the build instructions.
> 
> I added a reference to sys//conf to the bottom of the
> README.Adding something about NOTES might be helpful, but IMHO closer
> to the build.

Yes, but the directory doesn't tell you which file is the default kernel.
I'm thinking in terms of a random person browsing the tree via github's web
interface who doesn't know which files are which in which case I think this
note was kind of useful.

-- 
John Baldwin
___
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: r334073 - head

[Eitan Adler]

On 23 May 2018 at 09:27, John Baldwin  wrote:
> On Wednesday, May 23, 2018 04:09:01 AM Eitan Adler wrote:
>> Author: eadler
>> Date: Wed May 23 04:09:01 2018
>> New Revision: 334073
>> URL: https://svnweb.freebsd.org/changeset/base/334073
>>
>> Log:
>>   README: Reduce the textdump; describe the project
>>
>>   Rework the README to make it a little easier for new users. This is the
>>   first file many will see when persuing the FreeBSD source code so
>>
>>   - remove some of the text describes how to build. This is better covered
>>   in the linked documentation.
>>   - add a small blurb for what FreeBSD is. Some users might find this
>>   document through features such as github search so they may not even
>>   know what the project is
>>
>>   generally, gear this file for the new, accidental, or casual user rather
>>   than towards someone seeking fuller documentation.
>>
>> Modified:
>>   head/README
>>   head/README.md
>>
>> Modified: head/README
>> ==
>> --- head/README   Wed May 23 03:41:22 2018(r334072)
>> +++ head/README   Wed May 23 04:09:01 2018(r334073)
>> @@ -2,35 +2,25 @@ This is the top level of the FreeBSD source directory.
>> -
>> -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.
>
> I do think this paragraph is still useful as part of the Source Roadmap and
> not really part of the build instructions.

I added a reference to sys//conf to the bottom of the
README.Adding something about NOTES might be helpful, but IMHO closer
to the build.



-- 
Eitan Adler
Source, Ports, Doc committer
Bugmeister, Ports Security teams
___
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: r334073 - head

[John Baldwin]

On Wednesday, May 23, 2018 04:09:01 AM Eitan Adler wrote:
> Author: eadler
> Date: Wed May 23 04:09:01 2018
> New Revision: 334073
> URL: https://svnweb.freebsd.org/changeset/base/334073
> 
> Log:
>   README: Reduce the textdump; describe the project
>   
>   Rework the README to make it a little easier for new users. This is the
>   first file many will see when persuing the FreeBSD source code so
>   
>   - remove some of the text describes how to build. This is better covered
>   in the linked documentation.
>   - add a small blurb for what FreeBSD is. Some users might find this
>   document through features such as github search so they may not even
>   know what the project is
>   
>   generally, gear this file for the new, accidental, or casual user rather
>   than towards someone seeking fuller documentation.
> 
> Modified:
>   head/README
>   head/README.md
> 
> Modified: head/README
> ==
> --- head/README   Wed May 23 03:41:22 2018(r334072)
> +++ head/README   Wed May 23 04:09:01 2018(r334073)
> @@ -2,35 +2,25 @@ This is the top level of the FreeBSD source directory.
> -
> -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.

I do think this paragraph is still useful as part of the Source Roadmap and
not really part of the build instructions.

> -
> -
>  Source Roadmap:
>  ---
>  
> @@ -69,6 +59,8 @@ share   Shared resources.
>  standBoot loader sources.
>  
>  sys  Kernel sources.
> +
> +sys//conf Kernel configuration file
>  
>  testsRegression tests which can be run by Kyua.  See 
> tests/README
>   for additional information.
> 

-- 
John Baldwin
___
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: r334073 - head

[Benjamin Kaduk]

On Tue, May 22, 2018 at 11:09 PM, Eitan Adler  wrote:

> Author: eadler
> Date: Wed May 23 04:09:01 2018
> New Revision: 334073
> URL: https://svnweb.freebsd.org/changeset/base/334073
>
> Log:
>   README: Reduce the textdump; describe the project
>
>   Rework the README to make it a little easier for new users. This is the
>   first file many will see when persuing the FreeBSD source code so
>
>   - remove some of the text describes how to build. This is better covered
>   in the linked documentation.
>   - add a small blurb for what FreeBSD is. Some users might find this
>   document through features such as github search so they may not even
>   know what the project is
>
>   generally, gear this file for the new, accidental, or casual user rather
>   than towards someone seeking fuller documentation.
>
> Modified:
>   head/README
>   head/README.md
>

Changes to "the first file many will see when perusing the FreeBSD source
code" seem like something sufficiently impactful that pre-commit review
and/or
consultation with other committers would be advised.

(That said, these changes do seem reasonable, on a quick read.)

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