Add a note about temporary directories to --build help text #4944

1byxero · 2017-12-26T10:29:31Z

Added documentation on the usage of command line argument --build
Closes #4262

pradyunsg

Hi @1byxero! Thanks for this PR!

Just want a few minor grammar related changes. =)

(hopefully I don't come across as that annoying fellow who corrects your grammar) :P

pradyunsg · 2017-12-30T15:40:51Z

src/pip/_internal/cmdoptions.py

@@ -434,7 +434,10 @@ def only_binary():
    '-b', '--build', '--build-dir', '--build-directory',
    dest='build_dir',
    metavar='dir',
-    help='Directory to unpack packages into and build in.'
+    help='Directory to unpack packages into and build in. '
+         'Initial build would still take place in direcotry set by TMPDIR '


typo: directory

pradyunsg · 2017-12-30T15:50:20Z

src/pip/_internal/cmdoptions.py

-    help='Directory to unpack packages into and build in.'
+    help='Directory to unpack packages into and build in. '
+         'Initial build would still take place in direcotry set by TMPDIR '
+         'environment variable, (TEMP on windows) To change this behavior,'


an extra comma here after variable

To is capitalised in the middle of the sentence

windows should be Windows

there is no space after the last comma

pradyunsg · 2017-12-30T15:53:12Z

src/pip/_internal/cmdoptions.py

+    help='Directory to unpack packages into and build in. '
+         'Initial build would still take place in direcotry set by TMPDIR '
+         'environment variable, (TEMP on windows) To change this behavior,'
+         'set appropriate directory by setting TMPDIR environment variable'


Missing a trailing period

pradyunsg · 2017-12-30T15:54:02Z

Actually, on second thought, could you rephrase this to read as:

Directory to unpack packages into and build in. Note that an initial build still takes place in a temporary directory. The location of temporary directories can be controlled by setting the TMPDIR environment variable (TEMP on Windows) appropriately.

Thanks! :)

pradyunsg · 2017-12-30T15:58:08Z

@1byxero another thing you might want to do -- if you add the words "Closes #4262" to this PR description (the first comment by you), the relevant issue would be auto closed when this PR is merged. :)

1byxero · 2018-01-01T11:05:31Z

Sure. Will do all the changes you mentioned!

pradyunsg

LGTM, will merge if the CI approves.

=)

pradyunsg · 2018-01-01T11:42:54Z

Linters don't approve. One of the lines is too long and the indentation should be such that the quote of the continuation matches that of the line before it. Could you make these changes as well @1byxero? =)

pradyunsg · 2018-01-01T11:43:31Z

src/pip/_internal/cmdoptions.py

-        'Note that an initial build still takes place in a temporary directory. '
-        'The location of temporary directories can be controlled by setting '
+    help='Directory to unpack packages into and build in. Note that '
+        'an initial build still takes place in a temporary directory. The '


Add a space in this indentation.

yes i have checked the CI logs and have updated the help text accordingly

Ill monitor those things, and will fix the issues if any, will notify you with a mention when things will be looking fine

Sure! No hurries. :)

To run the linters locally, run tox -e lint-py3

1byxero · 2018-01-01T11:43:43Z

Yes updating those things to match the pep8 standards

1byxero · 2018-01-01T13:53:27Z

@pradyunsg hey So this CI looks good to me except packaging which failed due to

oci runtime error: exec failed: container_linux.go:265: starting container process caused "could not create session key: disk quota exceeded"

I ran the tox -e packaging locally and it succeded
So is there a way to restart a specific test so that we can retry that?

pradyunsg · 2018-01-01T14:01:07Z

I've restarted it.

1byxero · 2018-01-01T14:22:01Z

Looks like all checks have passed @pradyunsg
Pretty excited about getting my PR approved for pip.
One small question, when will this piece of code will be moved to the production version which will be used by the masses?

pradyunsg · 2018-01-01T15:30:24Z

Pretty excited about getting my PR approved for pip.

Congratulations! 🎉

when will this piece of code will be moved to the production version which will be used by the masses?

It'll be a part of pip 10, which is the next major release of pip. We don't really follow a release schedule but we're planning on doing one soon, once some work related to PEP 518 and all happens.

pradyunsg · 2018-01-01T15:34:03Z

@pypa/pip-committers Could one of you also take a look at this?

I'll be happy to merge once there's another approval on this. :)

1byxero · 2018-01-01T16:40:57Z

@pradyunsg Amazing!
Thanks.

pfmoore · 2018-01-01T18:15:15Z

Looks good to me - congratulations @1byxero and thanks for the contribution!

lock · 2019-06-02T15:06:33Z

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

Anuj Godase added 5 commits December 14, 2017 12:53

added documentation for build options

78c029b

Merge remote-tracking branch 'upstream/master'

d955f6a

added a news file

fa0e355

edited news file

19fd26d

used single quotes for uniformity in help strings

9adb7a7

pradyunsg self-assigned this Dec 26, 2017

pradyunsg reviewed Dec 30, 2017

View reviewed changes

1byxero changed the title ~~Documentation for setting up of a tmpdir, addresses issue #4262~~ Documentation for setting up of a tmpdir, addresses and Closes #4262 issue Jan 1, 2018

1byxero added 2 commits January 1, 2018 16:54

fixed grammer for --build help text

84b988a

updated --build help text

fd43611

pradyunsg approved these changes Jan 1, 2018

View reviewed changes

updated --build help text to match the pep8 standards

a97c0e4

pradyunsg reviewed Jan 1, 2018

View reviewed changes

pradyunsg changed the title ~~Documentation for setting up of a tmpdir, addresses and Closes #4262 issue~~ Add a note about temporary directories to --build help text Jan 1, 2018

1byxero added 3 commits January 1, 2018 17:18

fixed linting issue for --build help text

63738a5

fixed linting issue for --build help text

a71965d

fixed misalignment at --build command option help text

248064c

pfmoore approved these changes Jan 1, 2018

View reviewed changes

pradyunsg merged commit f038fe4 into pypa:master Jan 1, 2018

lock bot added the auto-locked Outdated issues that have been locked by automation label Jun 2, 2019

lock bot locked as resolved and limited conversation to collaborators Jun 2, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a note about temporary directories to --build help text #4944

Add a note about temporary directories to --build help text #4944

1byxero commented Dec 26, 2017 •

edited

pradyunsg left a comment •

edited

pradyunsg Dec 30, 2017

pradyunsg Dec 30, 2017

pradyunsg Dec 30, 2017

pradyunsg commented Dec 30, 2017

pradyunsg commented Dec 30, 2017

1byxero commented Jan 1, 2018

pradyunsg left a comment

pradyunsg commented Jan 1, 2018

pradyunsg Jan 1, 2018

1byxero Jan 1, 2018 •

edited

1byxero Jan 1, 2018

pradyunsg Jan 1, 2018

1byxero commented Jan 1, 2018

1byxero commented Jan 1, 2018 •

edited

pradyunsg commented Jan 1, 2018

1byxero commented Jan 1, 2018 •

edited

pradyunsg commented Jan 1, 2018

pradyunsg commented Jan 1, 2018

1byxero commented Jan 1, 2018

pfmoore commented Jan 1, 2018

lock bot commented Jun 2, 2019

Add a note about temporary directories to --build help text #4944

Add a note about temporary directories to --build help text #4944

Conversation

1byxero commented Dec 26, 2017 • edited

pradyunsg left a comment • edited

Choose a reason for hiding this comment

pradyunsg Dec 30, 2017

Choose a reason for hiding this comment

pradyunsg Dec 30, 2017

Choose a reason for hiding this comment

pradyunsg Dec 30, 2017

Choose a reason for hiding this comment

pradyunsg commented Dec 30, 2017

pradyunsg commented Dec 30, 2017

1byxero commented Jan 1, 2018

pradyunsg left a comment

Choose a reason for hiding this comment

pradyunsg commented Jan 1, 2018

pradyunsg Jan 1, 2018

Choose a reason for hiding this comment

1byxero Jan 1, 2018 • edited

Choose a reason for hiding this comment

1byxero Jan 1, 2018

Choose a reason for hiding this comment

pradyunsg Jan 1, 2018

Choose a reason for hiding this comment

1byxero commented Jan 1, 2018

1byxero commented Jan 1, 2018 • edited

pradyunsg commented Jan 1, 2018

1byxero commented Jan 1, 2018 • edited

pradyunsg commented Jan 1, 2018

pradyunsg commented Jan 1, 2018

1byxero commented Jan 1, 2018

pfmoore commented Jan 1, 2018

lock bot commented Jun 2, 2019

1byxero commented Dec 26, 2017 •

edited

pradyunsg left a comment •

edited

1byxero Jan 1, 2018 •

edited

1byxero commented Jan 1, 2018 •

edited

1byxero commented Jan 1, 2018 •

edited