From mboxrd@z Thu Jan  1 00:00:00 1970
From: Ian Campbell <ian.campbell@citrix.com>
Subject: Re: Missing Xen ARM documentation on the website
Date: Wed, 17 Jun 2015 11:10:37 +0100
Message-ID: <1434535837.13744.296.camel@citrix.com>
References: <5580A4B4.6010302@citrix.com> <5580C6BB.4020401@citrix.com>
	<5581431B.9060404@citrix.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Return-path: <xen-devel-bounces@lists.xen.org>
Received: from mail6.bemta14.messagelabs.com ([193.109.254.103])
	by lists.xen.org with esmtp (Exim 4.72)
	(envelope-from <prvs=6035412ff=Ian.Campbell@citrix.com>)
	id 1Z5AIs-0000cc-7n
	for xen-devel@lists.xenproject.org; Wed, 17 Jun 2015 10:10:42 +0000
In-Reply-To: <5581431B.9060404@citrix.com>
List-Unsubscribe: <http://lists.xen.org/cgi-bin/mailman/options/xen-devel>,
	<mailto:xen-devel-request@lists.xen.org?subject=unsubscribe>
List-Post: <mailto:xen-devel@lists.xen.org>
List-Help: <mailto:xen-devel-request@lists.xen.org?subject=help>
List-Subscribe: <http://lists.xen.org/cgi-bin/mailman/listinfo/xen-devel>,
	<mailto:xen-devel-request@lists.xen.org?subject=subscribe>
Sender: xen-devel-bounces@lists.xen.org
Errors-To: xen-devel-bounces@lists.xen.org
To: Julien Grall <julien.grall@citrix.com>
Cc: Andrew Cooper <andrew.cooper3@citrix.com>, Lars Kurth <lars.kurth@xen.org>, xen-devel <xen-devel@lists.xenproject.org>, Ian Jackson <Ian.Jackson@citrix.com>
List-Id: xen-devel@lists.xenproject.org

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,
>