Skip to content

NLnet M4 docs

Mark Overmeer edited this page Aug 21, 2025 · 3 revisions

Documentation website

OODoc

All MARKOV's Perl modules are released and documented using OODoc. About one man-month was spend to modernize the production process. The whole configuration system and central script oodist has been restructured.

Git reports the following size of changes from OODoc v2.01 upto v3.02:

 88 files changed, 4573 insertions(+), 2582 deletions(-)

To demonstrate the usefulness of the release tool, this is the size of the sources to be created: (output of linecount-perl)

files: 35
total: 11558         lines in release
documentation: 4657  lines of POD
code: 4881           lines of Perl code
comment: 327
blank: 2915

And this is the size of the release:

files: 62
total: 17725
documentation: 10414
code: 5010
comment: 505
blank: 6160

Especially the documentation is inflated, because of the automatic inheritance additions. The added texts are useful for the library user, but would require tedious manual documentation replication when not supported by OODoc.

Where the docs are inflated, the pm files are stripped from the docs, so much smaller. Code comments stay in, user docs get out. Using wc

# lines   bytes       (25 files)
  10278   275802      total development pm-files size
   6095   151690      total installed pm-file size
#  -40%     -45%      reduced size
Clone this wiki locally