[20456] in Kerberos_V5_Development
Re: Doxygen changes breaks krb5 documentation build
daemon@ATHENA.MIT.EDU (Paolo Greppi)
Tue Sep 12 18:22:15 2023
Message-ID: <ccd54644-81a7-6f9a-e1b3-d65c75423dca@libpf.com>
Date: Tue, 12 Sep 2023 09:01:05 +0200
MIME-Version: 1.0
Content-Language: en-US
To: 1051523@bugs.debian.org
From: Paolo Greppi <paolo.greppi@libpf.com>
CC: Sam Hartman <hartmans@debian.org>, Tianyu Chen <sweetyfish@deepin.org>,
<krbdev@mit.edu>
In-Reply-To: <tslmsxssfl9.fsf@suchdamage.org>
DIR:OUT; SFP:1022;
X-Auto-Response-Suppress: DR, OOF, AutoReply
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 Sep 2023 07:01:07.8746 (UTC)
X-MS-Exchange-CrossTenant-Network-Message-Id: 840341d0-259f-40ab-2f47-08dbb35e0a38
X-MS-Exchange-CrossTenant-Id: 64afd9ba-0ecf-4acf-bc36-935f6235ba8b
X-MS-Exchange-CrossTenant-AuthSource: SN1PEPF000252A4.namprd05.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Anonymous
X-MS-Exchange-CrossTenant-FromEntityHeader: Internet
X-MS-Exchange-Transport-CrossTenantHeadersStamped: IA0PR01MB8254
X-OriginatorOrg: mitprod.onmicrosoft.com
X-Mailman-Approved-At: Tue, 12 Sep 2023 18:21:14 -0400
X-Content-Filtered-By: Mailman/MimeDel 2.1.34
X-BeenThere: krbdev@mit.edu
X-Mailman-Version: 2.1.34
Precedence: list
List-Id: Kerberos Developers Mailing List <krbdev.mit.edu>
List-Unsubscribe: <https://mailman.mit.edu/mailman/options/krbdev>,
<mailto:krbdev-request@mit.edu?subject=unsubscribe>
List-Archive: <http://mailman.mit.edu/pipermail/krbdev/>
List-Post: <mailto:krbdev@mit.edu>
List-Help: <mailto:krbdev-request@mit.edu?subject=help>
List-Subscribe: <https://mailman.mit.edu/mailman/listinfo/krbdev>,
<mailto:krbdev-request@mit.edu?subject=subscribe>
Reply-To: paolo.greppi@libpf.com
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"; Format="flowed"
Errors-To: krbdev-bounces@mit.edu
Sender: "krbdev" <krbdev-bounces@mit.edu>
Il 11/09/23 20:57, Sam Hartman ha scritto:
>>>>>> "Tianyu" == Tianyu Chen <sweetyfish@deepin.org> writes:
>
>
> Tianyu> During a local rebuild of krb5, your package failed to
> Tianyu> build.
>
> So, I'm guessing this is related to the upgrade in Debian from doxygen
> 1.9.4 to 1.9.8.
>
> The krb5 build process uses doxygen to generate an xml representation of
> the documentation from a bunch of C header files. Then it uses a pile
> of python scripts which haven't seen much love since the days of python2
> to turn that documentation into rst, and then includes it in a sphinx
> document.
>
> It expects all the doxygen to be in a file called krb5_8hin.xml.
> Unfortunately the new doxygen is breaking up the sources into a bunch of
> different files and including <member> elements to refer to them rather
> than <memberdef> elements including their definition. And so the python
> doesn't find the definitions of the documented functions and the build
> fails because not many rst files are generated.
>
> I am hoping for help at this point.
> I'll continue to look into it, but I'm not familiar with the innards of
> doxygen, nor the xml parser that the krb5 python is using.
I tried running doxygen 1.9.4 and 1.9.8 from the respective Debian
packages in krb5/src/doc with this Doxyfile:
PROJECT_NAME = Kerberos_doxygen
OUTPUT_DIRECTORY = doxy
JAVADOC_AUTOBRIEF = YES
OPTIMIZE_OUTPUT_FOR_C = YES
WARN_IF_UNDOCUMENTED = NO
SHOW_FILES = NO
EXTENSION_MAPPING = hin=C
INPUT = ../../src/include/krb5/krb5.hin
../../doc/doxy_examples
EXAMPLE_PATH = ../../doc/doxy_examples
GENERATE_HTML = NO
GENERATE_LATEX = NO
GENERATE_XML = YES
PREDEFINED = KRB5_DEPRECATED KRB5_OLD_CRYPTO
CLASS_DIAGRAMS = NO
CASE_SENSE_NAMES = NO
QUIET = YES
and both produce 77 files in doxy/xml/, but some files are different.
In particular doxy/xml/krb5_8hin.xml shrinks from 1,9M to 742K, and many
memberdef elements are missing.
This may well be a doxygen bug, can anybody tell if there is any pattern?
Paolo
_______________________________________________
krbdev mailing list krbdev@mit.edu
https://mailman.mit.edu/mailman/listinfo/krbdev
