Page MenuHomePhabricator

[analyzer]Add user docs rst
ClosedPublic

Authored by martong on Jul 10 2019, 7:26 AM.

Details

Summary

Add user documentation page. This is an empty page atm, later patches will add
the specific user documentatoins.

Event Timeline

martong created this revision.Jul 10 2019, 7:26 AM
Herald added a project: Restricted Project. · View Herald TranscriptJul 10 2019, 7:26 AM
dkrupp accepted this revision.Jul 10 2019, 7:29 AM

I guess this is a placeholder for the subpages of "User Manual" @ https://clang-analyzer.llvm.org, which will be ported in follow-up patches.

This revision is now accepted and ready to land.Jul 10 2019, 7:29 AM

I guess this is a placeholder for the subpages of "User Manual" @ https://clang-analyzer.llvm.org, which will be ported in follow-up patches.

Yes.

This revision was automatically updated to reflect the committed changes.
Herald added a project: Restricted Project. · View Herald TranscriptJul 10 2019, 7:49 AM

I guess any time we modify analyzer stuff, we may invite the main analyzer developers to the patch review as well.

In any case, LGTM, if this really is a beginning of porting the already existing documentation to sphinx.

In any case, LGTM, if this really is a beginning of porting the already existing documentation to sphinx.

This is really the beginning of porting the existing docs to sphinx which is supposedly going to be done by @dkrupp. And I am planning to add new user manual documentation about CTU.

I guess any time we modify analyzer stuff, we may invite the main analyzer developers to the patch review as well.

Yes, I agree. I was under the impression that there is already a consensus between the analyzer devs about the sphinx movement. If there is not, please indicate and I'll revert.

Np, please leave it in! :)