Project

General

Profile

Task #3052

create jenkins job to create doxygen documentation for LibreOffice

Added by Christian Lohmaier about 1 year ago. Updated 6 months ago.

Status:
Closed
Priority:
Low
Category:
-
Target version:
Team - Q2/2020
Start date:
Due date:
% Done:

0%

Tags:
URL:

Description

currently the documentation is updated manually. To ease updating, there should be an admin job on jenkins for it.


Subtasks

Task #3090: Update doxygen on api.libreoffice.orgClosedChristian Lohmaier

Actions

History

#1

Updated by Florian Effenberger about 1 year ago

Is this really for Q4? :)

#2

Updated by Thorsten Behrens 10 months ago

If this takes longer - can then please someone update the API docs manually? We're currently at 6.2 FWICT...

#3

Updated by Christian Lohmaier 10 months ago

  • Target version changed from Q4/2020 to Q2/2020

oups, miscategorized really shouldn't take until the end of the year,
but to be clear this is meant as a job configuration in jenkins that still would be triggered manually. Doesn't make sense to constantly run that all the time.

#4

Updated by Florian Effenberger 10 months ago

oups, miscategorized really shouldn't take until the end of the year,
but to be clear this is meant as a job configuration in jenkins that
still would be triggered manually. Doesn't make sense to constantly run
that all the time.

Wrt. Thorsten's question, any chance to trigger a manual update soon?

#5

Updated by Christian Lohmaier 10 months ago

sure, already triggered a build....

#6

Updated by Christian Lohmaier 9 months ago

FYI: docs creation is aaaaawwwwfulllly slow (the job I did retrigger last week still is running....) and it is still creating files, so not fully stuck...

#7

Updated by Christian Lohmaier 9 months ago

  • Status changed from New to In Progress
#8

Updated by Christian Lohmaier 9 months ago

FYI: still running - seems it is exponential growth with each module it is processing...
drwxr-xr-x. 3 tdf users 31 Apr 7 23:35 sw
drwxr-xr-x. 3 tdf users 34 Apr 8 08:13 sysui
drwxr-xr-x. 3 tdf users 33 Apr 8 22:46 test
drwxr-xr-x. 3 tdf users 38 Apr 9 07:05 testtools
drwxr-xr-x. 3 tdf users 36 Apr 10 00:01 toolkit
drwxr-xr-x. 3 tdf users 34 Apr 16 05:08 tools
drwxr-xr-x. 3 tdf users 79 Apr 16 05:08 ucbhelper

Good thing is that the memory or other sytem requirements don't skyrocket...
So while not a problem per se to have a long running job, it requires to add more restrictions to the other linux build jobs/slave configurations (a buildslave needs to have three slots, but should only ever use a maximum of two of those for regular clang/gcc builds). So far the gcc and clang one are limited to run one job per node anyway, so that is covered, however the tinderbox job would happily claim the third slot without further restrictions. But not a big deal/more a FYI…

#9

Updated by Christian Lohmaier 9 months ago

/home/tdf/lode/jenkins/workspace/lo_tb_docs/solenv/bin/mkdocs.sh: line 175: 15025 Killed                  nice -15 doxygen "$DOXYGEN_CFG" >> $BASE_OUTPUT/doxygen.log 2>&1
Makefile:415: recipe for target 'docs' failed
make: *** [docs] Error 1

real    24267m51.087s
user    10363m52.785s
sys     6772m2.152s

sigh - doxygen/the docs job fell victim to OOM killer - not because of doxygen itself, but because the other builds had failures and the build then tries to run everything again in debugger, and just was bad luck that both did intersect and doxygen was the casualty. Unfortunately the docs generation is not incremental, so another minimum delay of two weeks for an update...
I'll rerun it on my own machine as well, that has a better single-core performance (Ryzen 5 2400G vs Xeon E5-2640 v3) and hopefully that will translate to doxygen as well.
#10

Updated by Christian Lohmaier 9 months ago

strangely enough run on my machine didn't take nearly as long, was done over the weekend, however almost-done docs dir on lilith is 12GB, while on mine is just 7.7GB (that kind of size difference is in the images, I'm sure - but need to double-check what's going on before replacing the files on api server...)

#11

Updated by Christian Lohmaier 9 months ago

  • Subject changed from create jenkins job to update api.libreoffice.org to create jenkins job to create doxygen documentation for LibreOffice
  • Priority changed from Normal to Low

ups, that was embarrassing - the api.libreoffice.org documentation actually is just the SDK documentation and thus doesn't really warrant it's own jenkins job - it's build as part of the regular release build, and even doing it standalone (in order to use a more current doxygen than baseline is quick).

Steps to update api.libreoffice.org: * sync api.libreoffice.org webroot to local machine * adjust index.html for the version you're updating it for * make odk.all in core checkout and sync instdir/sdk/docs and instdir/sdk/examples to the api.libreoffice.org tree/compare for a sanity check first * sync back to webroot

mixing doxygen versions should be avoided as version of doxygen is written to every file, making the sanity-checking harder than necessary.

Keeping this though, as having fully generated apidocs for core doesn't hurt (and is much more timeconsuming to create locally)

#12

Updated by Christian Lohmaier 6 months ago

  • Status changed from In Progress to Closed

docs.libreoffice.org has overall LO api documentation (not just SDK as api.libreoffice.org does) - and is automatically updated by a job on jenkins → closing

Also available in: Atom PDF