Page MenuHomePhabricator

Added instruction for clang format
ClosedPublic

Authored by tfu on Oct 3 2021, 5:43 PM.

Diff Detail

Repository
rDEVDOC Development Docs
Lint
Lint Not Applicable

Event Timeline

tfu requested review of this revision.Oct 3 2021, 5:43 PM
Restricted Application completed remote builds in Restricted Buildable.Oct 3 2021, 5:43 PM
jcmcdonald added inline comments.
source/tools/cpp.rst
152

Right prose, wrong place. Notice what else is not here: cppcheck, our static analyzer! Find where the setup for that appears in the docs, and put clang-format there instead.

This revision now requires changes to proceed.Oct 6 2021, 6:09 PM
  • Changed location of instrcution
Restricted Application completed remote builds in Restricted Buildable.Oct 10 2021, 5:58 PM
  • Changed location of instrcution
Restricted Application completed remote builds in Restricted Buildable.Oct 10 2021, 6:31 PM
  • Changed location of instrcution
Restricted Application completed remote builds in Restricted Buildable.Oct 10 2021, 6:32 PM

Excellent.

However, I do believe you also need the arcanist-clang-format-linter package?

Besides that, assuming nothing else is needed, this should be good to go.

This revision now requires changes to proceed.Oct 11 2021, 6:23 PM

Excellent.

However, I do believe you also need the arcanist-clang-format-linter package?

Besides that, assuming nothing else is needed, this should be good to go.

Oops, must have forgotten about that. I Will update that right now.

  • Added aranistt instructions
Restricted Application completed remote builds in Restricted Buildable.Oct 14 2021, 6:57 PM
jcmcdonald added inline comments.
source/tools/gitarc.rst
33

Just add the package here. It is not preinstalled.

168–169

All the instructions in this section should be folded into the Arcanist setup sections for each OS above.

172

Drop this section, and instead move the commands up into the respective OS-specific Arcanist setup instructions.

174

Locate how? Remember, the reader won't necessarily know Linux. I know you address this in your comment, but many readers will just stop reading as soon as they don't understand something.

Duplicate these instructions in the Linux, Alternative and macOS sections above.

This won't work as-is for Windows (e.g. locate). You'll need to work out those instructions separately and add them to that section, or else just link to the readme on that morefas-phabricator repository.

This revision now requires changes to proceed.Oct 15 2021, 1:39 PM

Got it, I will move the instructions to the appropriate places. Thanks for the correction.

  • Changed location of instructions
  • Deleted duplicates
  • added windows instructions
Restricted Application completed remote builds in Restricted Buildable.Oct 17 2021, 8:17 PM

Nice! Only a couple minor things now. Almost there!

source/tools/gitarc.rst
155

I think this would follow a different highlighting. cmd maybe? If in doubt, feel free to use text instead.

This revision now requires changes to proceed.Oct 18 2021, 6:57 AM
  • added windows instructions
Restricted Application completed remote builds in Restricted Buildable.Oct 22 2021, 7:06 PM
  • added windows instructions
Restricted Application completed remote builds in Restricted Buildable.Oct 22 2021, 7:09 PM
This revision is now accepted and ready to land.Oct 23 2021, 3:24 PM
This revision was automatically updated to reflect the committed changes.