docs

docs

[Jerker Nyberg]

There seem to be a missing argument to ceph osd lost (also in help for the 
command).

http://ceph.com/docs/master/rados/operations/control/#osd-subsystem

src/tools/ceph.cc
src/test/cli/ceph/help.t
doc/rados/operations/control.rst


The documentation for development release packages is slightly confused. 
Should it not refer to http://ceph.com/rpm-testing for development release 
packages? (Also, the ceph-release package in the development release does 
not refer to itself (in /etc/yum.repos.d/ceph.repo) but to 
(http://ceph.com/rpms) packages.)

http://ceph.com/docs/master/install/rpm/


Do you want patches?

--jerker

Re: docs

[Dan Mick]

On 03/22/2013 05:37 AM, Jerker Nyberg wrote:
>
> There seem to be a missing argument to ceph osd lost (also in help for
> the command).
>
> http://ceph.com/docs/master/rados/operations/control/#osd-subsystem
>

Indeed, it seems to be missing the id.  The CLI is getting a big rework 
right now, but the docs should be corrected.  Patch or file an issue, 
either way.

> src/tools/ceph.cc
> src/test/cli/ceph/help.t
> doc/rados/operations/control.rst
>
> The documentation for development release packages is slightly confused.
> Should it not refer to http://ceph.com/rpm-testing for development
> release packages? (Also, the ceph-release package in the development
> release does not refer to itself (in /etc/yum.repos.d/ceph.repo) but to
> (http://ceph.com/rpms) packages.)
>
> http://ceph.com/docs/master/install/rpm/
>
>
> Do you want patches?
>
> --jerker
> --
> To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: docs

[John Wilkins]

My meeting got cancelled today, so I'll work with Gary to get this resolved.

On Fri, Mar 22, 2013 at 11:18 AM, Dan Mick <dan.mick@inktank.com> wrote:
>
>
> On 03/22/2013 05:37 AM, Jerker Nyberg wrote:
>>
>>
>> There seem to be a missing argument to ceph osd lost (also in help for
>> the command).
>>
>> http://ceph.com/docs/master/rados/operations/control/#osd-subsystem
>>
>
> Indeed, it seems to be missing the id.  The CLI is getting a big rework
> right now, but the docs should be corrected.  Patch or file an issue, either
> way.
>
>
>> src/tools/ceph.cc
>> src/test/cli/ceph/help.t
>> doc/rados/operations/control.rst
>>
>> The documentation for development release packages is slightly confused.
>> Should it not refer to http://ceph.com/rpm-testing for development
>> release packages? (Also, the ceph-release package in the development
>> release does not refer to itself (in /etc/yum.repos.d/ceph.repo) but to
>> (http://ceph.com/rpms) packages.)
>>
>> http://ceph.com/docs/master/install/rpm/
>>
>>
>> Do you want patches?
>>
>> --jerker
>> --
>> To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
>> the body of a message to majordomo@vger.kernel.org
>> More majordomo info at  http://vger.kernel.org/majordomo-info.html
>
> --
> To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html



-- 
John Wilkins
Senior Technical Writer
Intank
john.wilkins@inktank.com
(415) 425-9599
http://inktank.com

Re: Docs

[Franklin PIAT]

On Sat, 2008-03-01 at 18:33 +0100, Yoshinori K. Okuji wrote:
> On Tuesday 26 February 2008 23:34, Yoshinori K. Okuji wrote:
> > On Monday 25 February 2008 08:43, Franklin PIAT wrote:
> > > Hello,
> > >
> > > On Sun, 2008-02-24 at 16:16 +0100, Robert Millan wrote:
> > > > On Wed, Feb 20, 2008 at 10:28:22PM +0100, Yoshinori K. Okuji wrote:
> > > > > > Currently I can't merge my work in a grub-v1 manual, as you
> > > > > > explained. What shall we do ?
> > > > >
> > > > > Why not? What we should do is to relicense the GRUB manual under GFDL
> > > > > with no Invariant Sections, and exchange the content. I already have
> > > > > an agreement with the FSF to change the license term to GFDL, so
> > > > > there is no problem.
> > > >
> > > > That is great news.  If it is with no front/back cover texts either,
> > > > I'll be able to include that in Debian!
> > > >
> > > > Thanks for the effort,
> > >
> > > I'm a bit confused on how we can move on...
> > > I would be more comfortable if you could you publish somewhere a
> > > re-licensed version of the manual, so I can work on it.
> >
> > OK. I will do it later. Maybe at this weekend.
> 
> So I have committed some files into the repository. I haven't written rules to 
> generate info yet, but you can start to modify grub.texi. I will finish the 
> build rules today.
> 
> Okuji

I will, Thank you.

Franklin

Re: Docs

[Yoshinori K. Okuji]

On Tuesday 26 February 2008 23:34, Yoshinori K. Okuji wrote:
> On Monday 25 February 2008 08:43, Franklin PIAT wrote:
> > Hello,
> >
> > On Sun, 2008-02-24 at 16:16 +0100, Robert Millan wrote:
> > > On Wed, Feb 20, 2008 at 10:28:22PM +0100, Yoshinori K. Okuji wrote:
> > > > > Currently I can't merge my work in a grub-v1 manual, as you
> > > > > explained. What shall we do ?
> > > >
> > > > Why not? What we should do is to relicense the GRUB manual under GFDL
> > > > with no Invariant Sections, and exchange the content. I already have
> > > > an agreement with the FSF to change the license term to GFDL, so
> > > > there is no problem.
> > >
> > > That is great news.  If it is with no front/back cover texts either,
> > > I'll be able to include that in Debian!
> > >
> > > Thanks for the effort,
> >
> > I'm a bit confused on how we can move on...
> > I would be more comfortable if you could you publish somewhere a
> > re-licensed version of the manual, so I can work on it.
>
> OK. I will do it later. Maybe at this weekend.

So I have committed some files into the repository. I haven't written rules to 
generate info yet, but you can start to modify grub.texi. I will finish the 
build rules today.

Okuji

Re: Docs

[Yoshinori K. Okuji]

On Monday 25 February 2008 08:43, Franklin PIAT wrote:
> Hello,
>
> On Sun, 2008-02-24 at 16:16 +0100, Robert Millan wrote:
> > On Wed, Feb 20, 2008 at 10:28:22PM +0100, Yoshinori K. Okuji wrote:
> > > > Currently I can't merge my work in a grub-v1 manual, as you
> > > > explained. What shall we do ?
> > >
> > > Why not? What we should do is to relicense the GRUB manual under GFDL
> > > with no Invariant Sections, and exchange the content. I already have an
> > > agreement with the FSF to change the license term to GFDL, so there is
> > > no problem.
> >
> > That is great news.  If it is with no front/back cover texts either, I'll
> > be able to include that in Debian!
> >
> > Thanks for the effort,
>
> I'm a bit confused on how we can move on...
> I would be more comfortable if you could you publish somewhere a
> re-licensed version of the manual, so I can work on it.

OK. I will do it later. Maybe at this weekend.

Okuji

Re: Docs

[Yoshinori K. Okuji]

On Sunday 24 February 2008 16:16, Robert Millan wrote:
> On Wed, Feb 20, 2008 at 10:28:22PM +0100, Yoshinori K. Okuji wrote:
> > > Currently I can't merge my work in a grub-v1 manual, as you explained.
> > > What shall we do ?
> >
> > Why not? What we should do is to relicense the GRUB manual under GFDL
> > with no Invariant Sections, and exchange the content. I already have an
> > agreement with the FSF to change the license term to GFDL, so there is no
> > problem.
>
> That is great news.  If it is with no front/back cover texts either, I'll
> be able to include that in Debian!

As we discussed, this is possible (and reasonable), until it is published as a 
printed version, or the manual is kept small enough.

Okuji

Re: Docs

[Franklin PIAT]

Hello,

On Sun, 2008-02-24 at 16:16 +0100, Robert Millan wrote:
> On Wed, Feb 20, 2008 at 10:28:22PM +0100, Yoshinori K. Okuji wrote:
> > > Currently I can't merge my work in a grub-v1 manual, as you explained.
> > > What shall we do ?
> > 
> > Why not? What we should do is to relicense the GRUB manual under GFDL with no 
> > Invariant Sections, and exchange the content. I already have an agreement 
> > with the FSF to change the license term to GFDL, so there is no problem.
> 
> That is great news.  If it is with no front/back cover texts either, I'll be
> able to include that in Debian!
> 
> Thanks for the effort,

I'm a bit confused on how we can move on...
I would be more comfortable if you could you publish somewhere a
re-licensed version of the manual, so I can work on it.

Franklin

Re: Docs

[Robert Millan]

On Wed, Feb 20, 2008 at 10:28:22PM +0100, Yoshinori K. Okuji wrote:
> > Currently I can't merge my work in a grub-v1 manual, as you explained.
> > What shall we do ?
> 
> Why not? What we should do is to relicense the GRUB manual under GFDL with no 
> Invariant Sections, and exchange the content. I already have an agreement 
> with the FSF to change the license term to GFDL, so there is no problem.

That is great news.  If it is with no front/back cover texts either, I'll be
able to include that in Debian!

Thanks for the effort,

-- 
Robert Millan

<GPLv2> I know my rights; I want my phone call!
<DRM> What use is a phone call… if you are unable to speak?
(as seen on /.)

Re: Docs

[Yoshinori K. Okuji]

On Monday 18 February 2008 23:08, Franklin PIAT wrote:
> Hi,
>
> On Thu, 2008-01-31 at 12:28 +0100, Yoshinori K. Okuji wrote:
> > On Thursday 31 January 2008 09:46, Franklin PIAT wrote:
> > > After some thoughts, I'll release the documentation[1] I wrote, with
> > > copyright assignments to FSF, Dual licensed under GPL+GFDL.
>
> I've received my FSF copyright assignments this morning. I'll post it
> tomorrow !

Thank you.

> Currently I can't merge my work in a grub-v1 manual, as you explained.
> What shall we do ?

Why not? What we should do is to relicense the GRUB manual under GFDL with no 
Invariant Sections, and exchange the content. I already have an agreement 
with the FSF to change the license term to GFDL, so there is no problem.

Okuji

Re: Docs

[Franklin PIAT]

Hi,

On Thu, 2008-01-31 at 12:28 +0100, Yoshinori K. Okuji wrote:
> On Thursday 31 January 2008 09:46, Franklin PIAT wrote:
> > After some thoughts, I'll release the documentation[1] I wrote, with
> > copyright assignments to FSF, Dual licensed under GPL+GFDL.

I've received my FSF copyright assignments this morning. I'll post it tomorrow !

Currently I can't merge my work in a grub-v1 manual, as you explained.
What shall we do ?
As an alternative, we could go for a lighter grub documentation, and keep 
the rest on the wiki http://grub.enbug.org/

Franklin

Re: Docs

[Franklin PIAT]

Hi,

Have you made progress regarding the re-licensing of the current grub
manual under GFDL ? (with no cover text and no invariant ?)

Franklin

On Thu, 2008-01-31 at 15:34 +0100, Robert Millan wrote:
> On Thu, Jan 31, 2008 at 02:43:59PM +0100, Yoshinori K. Okuji wrote:
> > On Thursday 31 January 2008 13:50, Robert Millan wrote:
> > > On Thu, Jan 31, 2008 at 12:28:50PM +0100, Yoshinori K. Okuji wrote:
> > > > Anyway, the best way of using texinfo is to start from examples. In our
> > > > case, you can copy the manual from GRUB Legacy, and tweak it. FYI, Emacs
> > > > supports texinfo very well.
> > >
> > > If the manual from GRUB Legacy (or a derived version under the same
> > > license) is in GFDL with invariant sections or front/back cover texts, I
> > > won't be able to add this in the Debian package.
> > >
> > > Is there a way we can get around this?  GFDL is fine as far as Debian is
> > > concerned, only invariant sections and front/back cover texts are a
> > > problem.
> > 
> > The GRUB manual is licensed under the traditional "as-is" term. It was only 
> > because GFDL hadn't been born yet when I wrote the manual, and I stopped 
> > working on GRUB Legacy when the FSF urged me to change the license.
> > 
> > As the manual is not so long, and the FSF hasn't published a paper version, we 
> > can omit Invariant Sections. However, we must change the license to GFDL in 
> > GRUB 2, anyway. You can see more info here:
> > 
> > http://www.gnu.org/prep/maintain/html_node/License-Notices-for-Documentation.html
> > 
> > If the FSF wants to print it out, I will not hesitate to add Invariant 
> > Sections. Actually, there was a chance that a printed version would be 
> > published, but it was not done, because I pointed out that it had some 
> > incomplete chapters, so not tolerable for the payment, and I didn't make 
> > effort on finishing them.
> 
> We can continue to work together in documentation untill that happens.  When it
> happens, I'll have to remove the docs in Debian, and will only add them back if
> someone forks the documentation (I don't have the motivation to do this myself,
> but maybe someone else will).  This doesn't preclude that someone else adds them
> to the non-free repository, but again I don't have the motivation to do this
> myself.
> 
> Please note that I don't necessarily agree with this policy;  in fact I think
> both sides have been overzealous on this, but it is nevertheless the policy that
> I have to abide to.
> 
> If you think we can avoid this situation by providing documentation as part
> of a non-GNU package (e.g. grub-doc), or just put it in the wiki, I'd welcome
> that.
> 

Re: Docs

[Franklin PIAT]

On Thu, January 31, 2008 15:34, Robert Millan wrote:
> We can continue to work together in documentation untill that happens.
I'll be away for a few days. I'll come back to you.

Franklin

Re: Docs

[Robert Millan]

On Thu, Jan 31, 2008 at 02:43:59PM +0100, Yoshinori K. Okuji wrote:
> On Thursday 31 January 2008 13:50, Robert Millan wrote:
> > On Thu, Jan 31, 2008 at 12:28:50PM +0100, Yoshinori K. Okuji wrote:
> > > Anyway, the best way of using texinfo is to start from examples. In our
> > > case, you can copy the manual from GRUB Legacy, and tweak it. FYI, Emacs
> > > supports texinfo very well.
> >
> > If the manual from GRUB Legacy (or a derived version under the same
> > license) is in GFDL with invariant sections or front/back cover texts, I
> > won't be able to add this in the Debian package.
> >
> > Is there a way we can get around this?  GFDL is fine as far as Debian is
> > concerned, only invariant sections and front/back cover texts are a
> > problem.
> 
> The GRUB manual is licensed under the traditional "as-is" term. It was only 
> because GFDL hadn't been born yet when I wrote the manual, and I stopped 
> working on GRUB Legacy when the FSF urged me to change the license.
> 
> As the manual is not so long, and the FSF hasn't published a paper version, we 
> can omit Invariant Sections. However, we must change the license to GFDL in 
> GRUB 2, anyway. You can see more info here:
> 
> http://www.gnu.org/prep/maintain/html_node/License-Notices-for-Documentation.html
> 
> If the FSF wants to print it out, I will not hesitate to add Invariant 
> Sections. Actually, there was a chance that a printed version would be 
> published, but it was not done, because I pointed out that it had some 
> incomplete chapters, so not tolerable for the payment, and I didn't make 
> effort on finishing them.

We can continue to work together in documentation untill that happens.  When it
happens, I'll have to remove the docs in Debian, and will only add them back if
someone forks the documentation (I don't have the motivation to do this myself,
but maybe someone else will).  This doesn't preclude that someone else adds them
to the non-free repository, but again I don't have the motivation to do this
myself.

Please note that I don't necessarily agree with this policy;  in fact I think
both sides have been overzealous on this, but it is nevertheless the policy that
I have to abide to.

If you think we can avoid this situation by providing documentation as part
of a non-GNU package (e.g. grub-doc), or just put it in the wiki, I'd welcome
that.

-- 
Robert Millan

<GPLv2> I know my rights; I want my phone call!
<DRM> What use is a phone call… if you are unable to speak?
(as seen on /.)

Re: Docs

[Yoshinori K. Okuji]

On Thursday 31 January 2008 13:50, Robert Millan wrote:
> On Thu, Jan 31, 2008 at 12:28:50PM +0100, Yoshinori K. Okuji wrote:
> > Anyway, the best way of using texinfo is to start from examples. In our
> > case, you can copy the manual from GRUB Legacy, and tweak it. FYI, Emacs
> > supports texinfo very well.
>
> If the manual from GRUB Legacy (or a derived version under the same
> license) is in GFDL with invariant sections or front/back cover texts, I
> won't be able to add this in the Debian package.
>
> Is there a way we can get around this?  GFDL is fine as far as Debian is
> concerned, only invariant sections and front/back cover texts are a
> problem.

The GRUB manual is licensed under the traditional "as-is" term. It was only 
because GFDL hadn't been born yet when I wrote the manual, and I stopped 
working on GRUB Legacy when the FSF urged me to change the license.

As the manual is not so long, and the FSF hasn't published a paper version, we 
can omit Invariant Sections. However, we must change the license to GFDL in 
GRUB 2, anyway. You can see more info here:

http://www.gnu.org/prep/maintain/html_node/License-Notices-for-Documentation.html

If the FSF wants to print it out, I will not hesitate to add Invariant 
Sections. Actually, there was a chance that a printed version would be 
published, but it was not done, because I pointed out that it had some 
incomplete chapters, so not tolerable for the payment, and I didn't make 
effort on finishing them.

Okuji

Re: Docs

[Robert Millan]

On Thu, Jan 31, 2008 at 12:28:50PM +0100, Yoshinori K. Okuji wrote:
> 
> Anyway, the best way of using texinfo is to start from examples. In our case, 
> you can copy the manual from GRUB Legacy, and tweak it. FYI, Emacs supports 
> texinfo very well.

If the manual from GRUB Legacy (or a derived version under the same license) is
in GFDL with invariant sections or front/back cover texts, I won't be able to
add this in the Debian package.

Is there a way we can get around this?  GFDL is fine as far as Debian is
concerned, only invariant sections and front/back cover texts are a problem.

-- 
Robert Millan

<GPLv2> I know my rights; I want my phone call!
<DRM> What use is a phone call… if you are unable to speak?
(as seen on /.)

Re: Docs

[Yoshinori K. Okuji]

On Thursday 31 January 2008 09:46, Franklin PIAT wrote:
> After some thoughts, I'll release the documentation[1] I wrote, with
> copyright assignments to FSF, Dual licensed under GPL+GFDL.

Thank you very much.

> I wish I could have left it on a Wiki, then do docbook/xml export, then
> converting it to info+manpages...
>
> * But I guess it won't be possible if we need copyright assignments
>   from contributors (although I think it might be possible to make some
>   group based ACLs in Moinmoin wiki).

I (or maybe Marco as well?) can set up an ACL, if you wish.

> * What do you think about maintaining the documentation in docbook
>   then converting it to texinfo ? Would it fit FSF Coding style ?

Docbook is acceptable. In fact, it is used in some projects in GNU (such as 
GNOME, IIRC).

But I think the problem is mostly the reusability. I believe that we can reuse 
several parts of the GRUB manual (for GRUB Legacy) as they are, and this is 
in texinfo format.

>   I've had a deeper look at Texinfo : The specification are larger
>   that html (i don't have the time to learn it)... And I haven't
>   fount authoring tool, etc...

It looks big, only because the texinfo manual contains a lot of examples. In 
reality, much smaller than the Docbook spec. And, you know, HTML does not 
specify printing.

Anyway, the best way of using texinfo is to start from examples. In our case, 
you can copy the manual from GRUB Legacy, and tweak it. FYI, Emacs supports 
texinfo very well.

Okuji

Docs

[Franklin PIAT]

Hello,

After some thoughts, I'll release the documentation[1] I wrote, with
copyright assignments to FSF, Dual licensed under GPL+GFDL.

I wish I could have left it on a Wiki, then do docbook/xml export, then
converting it to info+manpages...

* But I guess it won't be possible if we need copyright assignments 
  from contributors (although I think it might be possible to make some 
  group based ACLs in Moinmoin wiki).

* What do you think about maintaining the documentation in docbook 
  then converting it to texinfo ? Would it fit FSF Coding style ?

  I've had a deeper look at Texinfo : The specification are larger
  that html (i don't have the time to learn it)... And I haven't 
  fount authoring tool, etc...

Could you have a look at my work in the "manpages" section of :
 http://wiki.debian.org/Grub/Grub2
The grub.cfg page still needs quite some work, the other one are
almost ok (one final review from me, one from you, and one from
debian-i18n team to remove Franglish and other errors ).
Your comments are welcome !

Franklin