This is an archive of the discontinued LLVM Phabricator instance.

[LangRef] Reduce depth of table of contents
ClosedPublic

Authored by foad on Jul 27 2022, 7:19 AM.

Details

Summary

The table of contents in the HTML version of this doc takes up 25 pages
(in my browser, on my 4K monitor) and is too long for me to navigate
comfortably. And most of it is irrelevant detail like this:

  • Bitwise Binary Operations
    • 'shl' Instruction
      • Syntax:
      • Overview:
      • Arguments:
      • Semantics:
      • Example:
    • 'lshr' Instruction
      • Syntax:
      • Overview:
      • Arguments:
      • Semantics:
      • Example:

Reducing the contents depth from 4 to 3 removes most of this detail,
leaving just a list of instructions, which only takes up 7 pages and I
find it much easier to navigate.

Incidentally the depth was set to 3 when this document was first
converted to reST and was only increased to 4 in what looks like an
accidental change: 080133453bae62a43466e881ffc03fb7cffd7288

Diff Detail

Event Timeline

foad created this revision.Jul 27 2022, 7:19 AM
Herald added a project: Restricted Project. · View Herald TranscriptJul 27 2022, 7:19 AM
Herald added a subscriber: jdoerfert. · View Herald Transcript
foad requested review of this revision.Jul 27 2022, 7:19 AM
Herald added a project: Restricted Project. · View Herald TranscriptJul 27 2022, 7:19 AM
aaron.ballman accepted this revision.Jul 29 2022, 12:28 PM

LGTM, I think this balances readability a bit better this way, thanks!

This revision is now accepted and ready to land.Jul 29 2022, 12:28 PM
This revision was landed with ongoing or failed builds.Jul 29 2022, 1:15 PM
This revision was automatically updated to reflect the committed changes.