[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH 0/3] Use Doxygen and sphinx for html documentation


  • To: Julien Grall <julien@xxxxxxx>
  • From: Luca Fancellu <luca.fancellu@xxxxxxx>
  • Date: Wed, 7 Apr 2021 14:16:11 +0100
  • Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=arm.com; dmarc=pass action=none header.from=arm.com; dkim=pass header.d=arm.com; arc=none
  • Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=Q9fjCGMSbJoeByJce2V5STGBfy/TAZ/Mj3SIxLM0oHM=; b=bbTf3h2ruVPFSwrSPGojjpRSjD4pjfduhoQD49mtO1FeHheGitTAiH+VnNWDbuh9eAl7U3o31yWczSS0JCcp+7F10JUz21+45Nh3x8dzEAATGTs4ELpSVulvkBdkEPkYgM7hG1AZgu0e1hFyR4oPSdA6rOiwNxGxgycxVHihYGvJdfmH8jj7HSKIm8KEE0RxN6F5AOJQ51fIb0U5dASEPF69RQhum5iOnBqUcIqZytTyIFAUcguxoezZZfTA/gPic9ARSd6Ni6kdYXHw61b2pMJPjy2GadzlyepSvUKqOl/9+/BcK/F7l9cY8XRDfpqTQo6ZzC0NQ51TTjeqfjJXXw==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=D42hGDL/4TLogCcIo4n2Q4+PeS8OhXsccPVrkOOvAgfwhjMHtd8cFh57FoeXbxgO2h5qlz67iiZ4C+CYsULdsnHXsOwoxa8OZpCpo2KXWgJkEvxLsrrZg7WpIIzkgnj+tJN5xfWvOCL6euj2VGxah1m6yFAOk/HsIFT9vmudUIQiiFSzCSPiWYHck2t4NjXtB1K8qc/bLaeTeK6KORqvUYyoeczCvAtuGNdHybvM0z7bKRiV57CDlP6YsgjvVWj63wgUDkwPIm9sqrezJvdXw/m4gULlKvo8MdtmqYH8vXd6jIJzBNCMa5g3+eqSj8dm7LZjt16RKNAalGD6ybPgMw==
  • Authentication-results-original: xen.org; dkim=none (message not signed) header.d=none;xen.org; dmarc=none action=none header.from=arm.com;
  • Cc: xen-devel@xxxxxxxxxxxxxxxxxxxx, Bertrand Marquis <bertrand.marquis@xxxxxxx>, wei.chen@xxxxxxx, Andrew Cooper <andrew.cooper3@xxxxxxxxxx>, George Dunlap <george.dunlap@xxxxxxxxxx>, Ian Jackson <iwj@xxxxxxxxxxxxxx>, Jan Beulich <jbeulich@xxxxxxxx>, Stefano Stabellini <sstabellini@xxxxxxxxxx>, Wei Liu <wl@xxxxxxx>
  • Delivery-date: Wed, 07 Apr 2021 13:16:48 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
  • Nodisclaimer: true
  • Original-authentication-results: xen.org; dkim=none (message not signed) header.d=none;xen.org; dmarc=none action=none header.from=arm.com;


> On 7 Apr 2021, at 14:07, Julien Grall <julien@xxxxxxx> wrote:
> 
> 
> 
> On 06/04/2021 11:36, Luca Fancellu wrote:
>> This serie introduce doxygen in the sphinx html docs generation.
>> One benefit is to keep most of the documentation in the source
>> files of xen so that it's more maintainable, on the other hand
>> there are some limitation of doxygen that must be addressed
>> modifying the current codebase (for example doxygen can't parse
>> anonymous structure/union).
>> To reproduce the documentation xen must be compiled because
>> most of the headers are generated on compilation time from
>> the makefiles.
>> Here follows the steps to generate the sphinx html docs, some
>> package may be required on your machine, everything is suggested
>> by the autoconf script.
>> Here I'm building the arm64 docs (the only introduced for now by
>> this serie):
>> ./configure
>> make -C xen XEN_TARGET_ARCH="arm64" CROSS_COMPILE="aarch64-linux-gnu-" 
>> menuconfig
>> make -C xen XEN_TARGET_ARCH="arm64" CROSS_COMPILE="aarch64-linux-gnu-"
>> make -C docs XEN_TARGET_ARCH="arm64" sphinx-html
> 
> I have tried this instruction and got:
> 
> make: Entering directory '/home/ANT.AMAZON.COM/jgrall/works/oss/xen/docs'
> xen.doxyfile
> make: xen.doxyfile: Command not found
> Makefile:67: recipe for target 'sphinx-html' failed
> make: *** [sphinx-html] Error 127
> make: Leaving directory '/home/ANT.AMAZON.COM/jgrall/works/oss/xen/docs'
> 
> AFAICT, $DOXYGEN will only get defined when sphinx-build is installed.
> When sphinx-build is not installed SPHINXBUILD will be equal to 'no', but the 
> Makefile check for emptiness.
> 

Hi Julien,

Thank you for spotting it, I’ll fix it in the v2 patch

Cheers,
Luca

> Cheers,
> 
> -- 
> Julien Grall




 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.