This is an archive of the discontinued LLVM Phabricator instance.

Differential D62138

[Docs] Increase Doxygen cache size
ClosedPublic

Authored by jryans on May 20 2019, 5:59 AM.

Details

Reviewers
hintonda
jmorse
Commits
rZORGef1afe076492: [Docs] Increase Doxygen cache size
rGef1afe076492: [Docs] Increase Doxygen cache size
rG120a6f09bb95: [Docs] Increase Doxygen cache size
rL361343: [Docs] Increase Doxygen cache size
rC361343: [Docs] Increase Doxygen cache size
Summary

When building Doxygen docs for llvm and clang, it helpfully prints a warning at
the end noting that the LOOKUP_CACHE_SIZE value was too small to keep all
symbols in memory.

By increasing to the size it recommends, Doxygen builds have greatly improved
performance. On my machine, time to run doxygen-llvm changes from 34 minutes
to 22 minutes, which is a decent amount of time saved by changing a single
number.

Diff Detail

Event Timeline

jryans created this revision.May 20 2019, 5:59 AM
Herald added projects: Restricted Project, Restricted Project. · View Herald TranscriptMay 20 2019, 5:59 AM
Herald added subscribers: llvm-commits, cfe-commits. · View Herald Transcript
Harbormaster completed remote builds in B32149: Diff 200261.May 20 2019, 5:59 AM
jryans added reviewers: hintonda, jmorse.May 20 2019, 6:07 AM
jryans added a comment.May 20 2019, 6:37 AM

I don't currently have commit access, so I would need someone to land this for me assuming it's approved. If it would be easier for me to submit separate patches for the llvm and clang changes, please let me know! 😄

hintonda accepted this revision.May 20 2019, 7:32 AM

Thanks, LGTM!

I'll give it a day for further comments, and barring any, commit it for you tomorrow.

This revision is now accepted and ready to land.May 20 2019, 7:32 AM
Closed by commit rC361343: [Docs] Increase Doxygen cache size (authored by dhinton). · Explain WhyMay 21 2019, 5:54 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathSize
clang/
docs/
2 lines
llvm/
docs/
2 lines

Diff 200261

clang/docs/doxygen.cfg.in

Show First 20 Lines • Show All 378 Lines • ▼ Show 20 Lines
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# doxygen will become slower. If the cache is too large, memory is wasted. The # doxygen will become slower. If the cache is too large, memory is wasted. The
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# symbols. At the end of a run doxygen will report the cache usage and suggest # symbols. At the end of a run doxygen will report the cache usage and suggest
# the optimal cache size from a speed point of view. # the optimal cache size from a speed point of view.
# Minimum value: 0, maximum value: 9, default value: 0. # Minimum value: 0, maximum value: 9, default value: 0.
LOOKUP_CACHE_SIZE = 2 LOOKUP_CACHE_SIZE = 3
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Build related configuration options # Build related configuration options
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available. Private # documentation are documented, even if no documentation was available. Private
# class members and static file members will be hidden unless the # class members and static file members will be hidden unless the
▲ Show 20 Lines • Show All 1,898 Lines • Show Last 20 Lines

llvm/docs/doxygen.cfg.in

Show First 20 Lines • Show All 379 Lines • ▼ Show 20 Lines
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# doxygen will become slower. If the cache is too large, memory is wasted. The # doxygen will become slower. If the cache is too large, memory is wasted. The
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# symbols. At the end of a run doxygen will report the cache usage and suggest # symbols. At the end of a run doxygen will report the cache usage and suggest
# the optimal cache size from a speed point of view. # the optimal cache size from a speed point of view.
# Minimum value: 0, maximum value: 9, default value: 0. # Minimum value: 0, maximum value: 9, default value: 0.
LOOKUP_CACHE_SIZE = 2 LOOKUP_CACHE_SIZE = 4
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Build related configuration options # Build related configuration options
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available. Private # documentation are documented, even if no documentation was available. Private
# class members and static file members will be hidden unless the # class members and static file members will be hidden unless the
▲ Show 20 Lines • Show All 1,898 Lines • Show Last 20 Lines