Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document pantsd startup and Pailgun behaviours #7376

Merged

Conversation

Projects
None yet
3 participants
@blorente
Copy link
Contributor

commented Mar 13, 2019

Problem

The codepaths that executing pants with --enable-pantsd are hard to understand. While there are good in-place comments, there is not an end-to-end high level description of the components in play and their interaction.

Solution

Write up that documentation. Specifically, this addition aims to explain what happens when you run ./pants --enable-pantsd list src/scala:: while pantsd is off, and give a high-level overview of the components necessary to understand that codepath.

Result

Documentation changes in pantsbuild.org, which contain:

  • Descriptions of ProcessManager, PantsDaemon, PantsService, the Pailgun protocol and the classes related to its functioning.
  • An end-to-end example with links to the code.

This is reviewable (because what's there is unlikely to change), but there is work to be done before this is mergeable:

  • Add introduction paragraph which describes the high-level goal of Pantsd.
  • Add links to the repo for the classes mentioned here. We may not need link to every method, but links to every class would be nice.
  • Integrate with the pantsbuild.org website, possibly as a tab on the left.

Closes #5114
Related to #6069, possibly closing it

@stuhood
Copy link
Member

left a comment

Looks good, thanks!

I wonder if it would be worth it to actually include this in an "Architecture" section of the docsite? See https://www.pantsbuild.org/docs.html

Show resolved Hide resolved src/docs/pantsd.md Outdated

@Eric-Arellano Eric-Arellano self-requested a review Mar 13, 2019

@ity

ity approved these changes Mar 14, 2019

Copy link
Contributor

left a comment

thank you for doing this - excellent!

blorente added some commits Mar 18, 2019

@stuhood

This comment has been minimized.

Copy link
Member

commented Mar 20, 2019

Feel free to merge!

@blorente blorente merged commit 7c248ae into pantsbuild:master Mar 20, 2019

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.