This is an archive of the discontinued LLVM Phabricator instance.

[lldb] Add a "design" section to the documentation.
ClosedPublic

Authored by JDevlieghere on Sep 29 2020, 3:12 PM.

Details

Reviewers
jingham
Group Reviewers
Restricted Project
Commits
rG128e999d63c4: [lldb] Add a "design" section to the documentation.
Summary

Create a "Design" section for the LLDB documentation. The goal would be to have design documents that describe how the LLDB internals work. Currently they're mixed together under the "Development" section which hurts discoverability and makes it harder to understand where a new page should go. The existing pages describing the reproducers, the structured data plugins, and the SB API could be housed here but I'd love to see more pages being added here in the future.

Diff Detail

Event Timeline

JDevlieghere created this revision.Sep 29 2020, 3:12 PM
JDevlieghere requested review of this revision.Sep 29 2020, 3:12 PM
aprantl added a subscriber: aprantl.Oct 1 2020, 4:25 PM

What's the difference between design/ and architecture/? These sounds like synonyms to me.

jingham accepted this revision.Oct 1 2020, 4:26 PM
jingham added a subscriber: jingham.

LGTM

This revision is now accepted and ready to land.Oct 1 2020, 4:26 PM

What's the difference between design/ and architecture/? These sounds like synonyms to me.

Good point, that page should be moved under the new section as well. Maybe we should call the section "Architecture" and rename that page to "Overview" when nested underneath?

Ah, Adrian is right, you should probably move Architecture to Design.

I like the name Design better than Architecture for the top level. For instance the structureddataplugins is not really Architecture, it's the design of a fairly small component of lldb

Architecture is more specific to the structural aspect of a thing, whereas Design is more general. For instance, the rules for the SB API don’t really seem like a description of an Architecture, but more some general principles for doing the thing.

Jim

Move architecture under design and rename the page to overview.

This revision was automatically updated to reflect the committed changes.
Herald added a project: Restricted Project. · View Herald TranscriptOct 2 2020, 1:08 PM