Missing Xen ARM documentation on the website

Missing Xen ARM documentation on the website

[Julien Grall]

Hi,

It seems that the online documentation [1] doesn't contain the ARM part. 
It's a directory under docs/misc.

I'm happy to fix it if someone point me to the scripts which generate 
the online doc.

Regards,

[1] http://xenbits.xen.org/docs/unstable/

-- 
Julien Grall

Re: Missing Xen ARM documentation on the website

[Andrew Cooper]

On 16/06/2015 23:35, Julien Grall wrote:
> Hi,
>
> It seems that the online documentation [1] doesn't contain the ARM
> part. It's a directory under docs/misc.
>
> I'm happy to fix it if someone point me to the scripts which generate
> the online doc.
>
> Regards,
>
> [1] http://xenbits.xen.org/docs/unstable/
>

It looks like you just need to extend the globs in the "Documentation
sources" section near the top of docs/Makefile.  They currently don't
recurse into misc/arm/.  Perhaps also a tweak to docs/gen-html-index,
but it looks as if it should be able to cope with subdirectories.

It might be worth using $(shell find $XXX) to collect all documents of a
specific src type, which would be more resilient to addition of new
subdirs in the future.  The rest of the makefile should be able to cope.

~Andrew

Re: Missing Xen ARM documentation on the website

[Julien Grall]

Hi,

On 17/06/2015 02:00, Andrew Cooper wrote:
> On 16/06/2015 23:35, Julien Grall wrote:
>> Hi,
>>
>> It seems that the online documentation [1] doesn't contain the ARM
>> part. It's a directory under docs/misc.
>>
>> I'm happy to fix it if someone point me to the scripts which generate
>> the online doc.
>>
>> Regards,
>>
>> [1] http://xenbits.xen.org/docs/unstable/
>>
>
> It looks like you just need to extend the globs in the "Documentation
> sources" section near the top of docs/Makefile.  They currently don't
> recurse into misc/arm/.  Perhaps also a tweak to docs/gen-html-index,
> but it looks as if it should be able to cope with subdirectories.

It looks that gen-html-index needs to be modified. When you have 2 file 
with the same name, the final result it:

<li><a href="arm/passthrough.txt">passthrough</a></li>
<li><a href="arm/device-tree/passthrough.txt">passthrough</a></li>

I guess we want to print the directory name (or something similar) and 
add another layer of indentation:
    Misc
      Arm
        passthrough
        device-tree
           passthrough

> It might be worth using $(shell find $XXX) to collect all documents of a
> specific src type, which would be more resilient to addition of new
> subdirs in the future.  The rest of the makefile should be able to cope.

Good idea.

Regards,

-- 
Julien Grall

Re: Missing Xen ARM documentation on the website

[Ian Campbell]

On Wed, 2015-06-17 at 10:51 +0100, Julien Grall wrote:
> Hi,
> 
> On 17/06/2015 02:00, Andrew Cooper wrote:
> > On 16/06/2015 23:35, Julien Grall wrote:
> >> Hi,
> >>
> >> It seems that the online documentation [1] doesn't contain the ARM
> >> part. It's a directory under docs/misc.
> >>
> >> I'm happy to fix it if someone point me to the scripts which generate
> >> the online doc.
> >>
> >> Regards,
> >>
> >> [1] http://xenbits.xen.org/docs/unstable/
> >>
> >
> > It looks like you just need to extend the globs in the "Documentation
> > sources" section near the top of docs/Makefile.  They currently don't
> > recurse into misc/arm/.  Perhaps also a tweak to docs/gen-html-index,
> > but it looks as if it should be able to cope with subdirectories.
> 
> It looks that gen-html-index needs to be modified. When you have 2 file 
> with the same name, the final result it:
> 
> <li><a href="arm/passthrough.txt">passthrough</a></li>
> <li><a href="arm/device-tree/passthrough.txt">passthrough</a></li>
> 
> I guess we want to print the directory name (or something similar) and 
> add another layer of indentation:
>     Misc
>       Arm
>         passthrough
>         device-tree
>            passthrough

Probably, yes.

Independently of that you may also want to consider updating docs/INDEX
to give things real titles rather than just their filename.

> 
> > It might be worth using $(shell find $XXX) to collect all documents of a
> > specific src type, which would be more resilient to addition of new
> > subdirs in the future.  The rest of the makefile should be able to cope.
> 
> Good idea.
> 
> Regards,
> 

Re: Missing Xen ARM documentation on the website

[Julien Grall]

On 17/06/15 11:10, Ian Campbell wrote:
>> I guess we want to print the directory name (or something similar) and 
>> add another layer of indentation:
>>     Misc
>>       Arm
>>         passthrough
>>         device-tree
>>            passthrough
> 
> Probably, yes.
> 
> Independently of that you may also want to consider updating docs/INDEX
> to give things real titles rather than just their filename.

This solution will be simpler for now. I will update docs/INDEX.

Regards,

-- 
Julien Grall