Added bootstrap.rst

Added bootstrap.rst

This replaces bootstrap/README.md.

BUG=

Committed: https://chromium.googlesource.com/infra/infra/+/bdf093963fa9f19d8245266c5048e31ada21ce68

[pgervais, 2014-12-03 01:38:15]

pgervais@chromium.org changed reviewers:
+ iannucci@chromium.org, tandrii@chromium.org

[pgervais, 2014-12-03 01:38:15]

This CL replaces the README.md file by an rst one, linked from the 'official'
documentation'. 

iannucci: because you wrote the original document.
tandrii: because you did not write the original document.

[tandrii(chromium), 2014-12-04 00:58:17]

LGTM 

From a first time reader perspective, the new rst file makes a lot of sense to
me. It's harder for me to check it for correctness, so I'll leave this to
iannucci .

[iannucci, 2014-12-08 10:41:07]

lgtm

https://codereview.chromium.org/775763005/diff/20001/doc/source/bootstrap.rst
File doc/source/bootstrap.rst (right):

https://codereview.chromium.org/775763005/diff/20001/doc/source/bootstrap.rst...
doc/source/bootstrap.rst:8: 1: http://legacy.python.org/dev/peps/pep-0427/
https link: https://www.python.org/dev/peps/pep-0427/

unless you wanted the legacy version for some reason?

https://codereview.chromium.org/775763005/diff/20001/doc/source/bootstrap.rst...
doc/source/bootstrap.rst:36:
``chromium.googlesource.com/infra/third_party/my_pkg``
File a ticket..... to ``chromium.googlesource.com/external/<repo_url>``

https://codereview.chromium.org/775763005/diff/20001/doc/source/bootstrap.rst...
doc/source/bootstrap.rst:57: platform.
This should probably be bold or something. This is an important note.

https://codereview.chromium.org/775763005/diff/20001/doc/source/bootstrap.rst...
doc/source/bootstrap.rst:74: Run ``gclient runhooks``. Under the hood, this is
running::
pedantic/nit: s/is running/runs/

https://codereview.chromium.org/775763005/diff/20001/doc/source/bootstrap.rst...
doc/source/bootstrap.rst:80: your system cached in ``{repo_root}/.wheelcache``.
should we be wrapping at 80 everywhere?

https://codereview.chromium.org/775763005/diff/20001/doc/source/bootstrap.rst...
doc/source/bootstrap.rst:122: 4:
not sure what the `4:` is for?

May also want to explain in this section that the 'package_name' should be the
pip-reported package name (e.g. what setup.py claims that package to be named).
This may differ from the import name (e.g. PyYAML v yaml), and it may differ
from the wheel name (dashes, spaces to underscores, etc).

https://codereview.chromium.org/775763005/diff/20001/doc/source/bootstrap.rst...
doc/source/bootstrap.rst:175: a ``.whl`` file after Build completes.
Note that your Build function will actually need to invoke pip manually.
Currently you can get the path for pip by doing: `os.path.join(sys.prefix,
'bin', 'pip')`**, and you can invoke it with subprocess (see
https://code.google.com/p/chromium/codesearch#chromium/infra/bootstrap/custom...
as an example). It's not a very nice API... we should probably pass in a pip()
function to Build to encapsulate this.


** Actually... I don't think this'll work on windows because it'll be Scripts
instead of bin >_<.

[pgervais, 2014-12-09 01:44:30]

Thanks for your review!

https://chromiumcodereview.appspot.com/775763005/diff/20001/doc/source/bootst...
File doc/source/bootstrap.rst (right):

https://chromiumcodereview.appspot.com/775763005/diff/20001/doc/source/bootst...
doc/source/bootstrap.rst:8: 1: http://legacy.python.org/dev/peps/pep-0427/
On 2014/12/08 10:41:06, iannucci wrote:
> https link: https://www.python.org/dev/peps/pep-0427/
> 
> unless you wanted the legacy version for some reason?

Done.

https://chromiumcodereview.appspot.com/775763005/diff/20001/doc/source/bootst...
doc/source/bootstrap.rst:36:
``chromium.googlesource.com/infra/third_party/my_pkg``
On 2014/12/08 10:41:06, iannucci wrote:
> File a ticket..... to ``chromium.googlesource.com/external/<repo_url>``

Done.

https://chromiumcodereview.appspot.com/775763005/diff/20001/doc/source/bootst...
doc/source/bootstrap.rst:57: platform.
On 2014/12/08 10:41:06, iannucci wrote:
> This should probably be bold or something. This is an important note.

Done.

https://chromiumcodereview.appspot.com/775763005/diff/20001/doc/source/bootst...
doc/source/bootstrap.rst:74: Run ``gclient runhooks``. Under the hood, this is
running::
On 2014/12/08 10:41:06, iannucci wrote:
> pedantic/nit: s/is running/runs/

This is not being pedantic, this is writing proper English. Thanks for pointing
that out.

https://chromiumcodereview.appspot.com/775763005/diff/20001/doc/source/bootst...
doc/source/bootstrap.rst:80: your system cached in ``{repo_root}/.wheelcache``.
On 2014/12/08 10:41:06, iannucci wrote:
> should we be wrapping at 80 everywhere?

Yes, as much as possible. Sometimes hard with very long URLs.

https://chromiumcodereview.appspot.com/775763005/diff/20001/doc/source/bootst...
doc/source/bootstrap.rst:122: 4:
On 2014/12/08 10:41:06, iannucci wrote:
> not sure what the `4:` is for?
> 
> May also want to explain in this section that the 'package_name' should be the
> pip-reported package name (e.g. what setup.py claims that package to be
named).
> This may differ from the import name (e.g. PyYAML v yaml), and it may differ
> from the wheel name (dashes, spaces to underscores, etc).

Dropped and fixed.

https://chromiumcodereview.appspot.com/775763005/diff/20001/doc/source/bootst...
doc/source/bootstrap.rst:175: a ``.whl`` file after Build completes.
On 2014/12/08 10:41:06, iannucci wrote:
> Note that your Build function will actually need to invoke pip manually.
> Currently you can get the path for pip by doing: `os.path.join(sys.prefix,
> 'bin', 'pip')`**, and you can invoke it with subprocess (see
>
https://code.google.com/p/chromium/codesearch#chromium/infra/bootstrap/custom...
> as an example). It's not a very nice API... we should probably pass in a pip()
> function to Build to encapsulate this.
> 
> 
> ** Actually... I don't think this'll work on windows because it'll be Scripts
> instead of bin >_<.

Added the first paragraph, dropped the footnote.

[pgervais, 2014-12-09 01:44:34]

The CQ bit was checked by pgervais@chromium.org

[commit-bot: I haz the power, 2014-12-09 01:44:58]

CQ is trying da patch. Follow status at
 https://chromium-cq-status.appspot.com/patch-status/775763005/40001

[commit-bot: I haz the power, 2014-12-09 01:47:16]

Committed patchset #3 (id:40001) as
https://chromium.googlesource.com/infra/infra/+/bdf093963fa9f19d8245266c5048e...