where is Documentation/parameters.txt?

where is Documentation/parameters.txt?

[Robert P. J. Day]

  in the file Documentation/devices_drivers.txt, one reads:

"See Documentation/parameters.txt for more info."

is this file supposed to exist?

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Re: where is Documentation/parameters.txt?

[Sascha Hauer]

Robert,

On Thu, Jun 26, 2014 at 05:27:03PM -0400, Robert P. J. Day wrote:
> 
>   in the file Documentation/devices_drivers.txt, one reads:
> 
> "See Documentation/parameters.txt for more info."
> 
> is this file supposed to exist?

Please don't waste your time with the old documentation. The new docs
are in the "doc" branch in the barebox master repository.

Sascha

-- 
Pengutronix e.K.                           |                             |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Re: where is Documentation/parameters.txt?

[Robert P. J. Day]

On Fri, 27 Jun 2014, Sascha Hauer wrote:

> Robert,
>
> On Thu, Jun 26, 2014 at 05:27:03PM -0400, Robert P. J. Day wrote:
> >
> >   in the file Documentation/devices_drivers.txt, one reads:
> >
> > "See Documentation/parameters.txt for more info."
> >
> > is this file supposed to exist?
>
> Please don't waste your time with the old documentation. The new docs
> are in the "doc" branch in the barebox master repository.

  oh, sorry, i missed that doc *branch*, my fault.

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Re: where is Documentation/parameters.txt?

[Holger Schurig]

>   oh, sorry, i missed that doc *branch*, my fault.

It's totally new ... and awesome (compared to the old docs).

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Re: where is Documentation/parameters.txt?

[Robert P. J. Day]

On Fri, 27 Jun 2014, Holger Schurig wrote:

> >   oh, sorry, i missed that doc *branch*, my fault.
>
> It's totally new ... and awesome (compared to the old docs).

  ok, possibly a silly question but, as i now read it, if i want to
work with the sphinx-based docs, i should be working off the "doc"
branch and restrict my changes to just the files in the Documentation
directory.

  but recently, i submitted a patch to correct the misspelling
"persistant", and some of those changes were in Documentation/, while
other examples of that were scattered elsewhere (arch/, scripts/).

  so what's the protocol for correcting "documentation" (eg., inline
comments in source files) as opposed to the content under
Documentation? should non-Documentation patches be submitted against
the master branch? or does the "doc" branch track master closely
enough that i can exclusively stay on the "doc" branch?

  as in, should i resubmit that earlier patch broken into two parts?
and if one submits a patch against the "doc" branch, should that be
identified in the patch itself? the subject line?

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================



_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Re: where is Documentation/parameters.txt?

[Holger Schurig]

The doc branch deleted all of the *.dox files. And it will eventually
be merged into master and/or next. So I see not much point into
working on the *.dox files anymore. They are basically end-of-life.

Instead, you can either do doc-related work in the origin/doc branch,
or merge that branch into your local work branch.

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Re: where is Documentation/parameters.txt?

[Sascha Hauer]

On Fri, Jun 27, 2014 at 07:49:49AM -0400, Robert P. J. Day wrote:
> On Fri, 27 Jun 2014, Holger Schurig wrote:
> 
> > >   oh, sorry, i missed that doc *branch*, my fault.
> >
> > It's totally new ... and awesome (compared to the old docs).
> 
>   ok, possibly a silly question but, as i now read it, if i want to
> work with the sphinx-based docs, i should be working off the "doc"
> branch and restrict my changes to just the files in the Documentation
> directory.
> 
>   but recently, i submitted a patch to correct the misspelling
> "persistant", and some of those changes were in Documentation/, while
> other examples of that were scattered elsewhere (arch/, scripts/).

That's fine. I'll solve the merges conflicts.

> 
>   so what's the protocol for correcting "documentation" (eg., inline
> comments in source files) as opposed to the content under
> Documentation? should non-Documentation patches be submitted against
> the master branch? or does the "doc" branch track master closely
> enough that i can exclusively stay on the "doc" branch?
> 
>   as in, should i resubmit that earlier patch broken into two parts?
> and if one submits a patch against the "doc" branch, should that be
> identified in the patch itself? the subject line?

Please send documentation patches only against the doc branch. I'll
resolve the merge conflicts against master should there be any.

Sascha

-- 
Pengutronix e.K.                           |                             |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox