Issue1707 doc simply use x #1710

sslime336 · 2023-06-30T17:31:49Z

resolves #1707

src/building/how-to-build-and-run.md

jyn514 · 2023-07-01T04:42:28Z

src/building/how-to-build-and-run.md

+Using `x` rather than `x.py` is recommended as:
+
+> `./x` is the most likely to work on every system (on Unix it runs the shell script
+> that does python version detection, on Windows it will probably run the
+> powershell script - certainly less likely to break than `./x.py` which often just
+> opens the file in an editor).[^1]
+
+Notice that this is not absolute, for instance, using Nushell in VSCode on Win10,
+typing `x` or `./x` still open the `x.py` in editor rather invoke the program :)
+
+In the rest of documents, we use `x` to represent the straightly usage of `x.py`, which
+means the following command:
+
+```bash
+./x check
+```
+
+could be replaced by:
+
+```bash
+./x.py check


this confuses the global x binary with the local ./x shell script. This section is about the global binary.

It's fine to add this paragraph, but please put it in the section above, "Running x.py".

Update books ## rust-lang/book 1 commits in 21cf840842bdf768a798869f06373c96c1cc5122..668c64760b5c7ea654facb4ba5fe9faddfda27cc 2023-06-29 13:50:36 UTC to 2023-06-29 13:50:36 UTC - Remove adjective about what kind of number this is ## rust-lang/edition-guide 2 commits in f63e578b92ff43e8cc38fcaa257b660f45c8a8c2..2751bdcef125468ea2ee006c11992cd1405aebe5 2023-07-10 14:29:51 UTC to 2023-07-08 18:05:44 UTC - Update a link to a section in the cargo workspaces. (rust-lang/edition-guide#283) - b'...' byte strings -> byte chars (rust-lang/edition-guide#282) ## rust-embedded/book 2 commits in f2aed2fe8e9f55508c86ba3aa4b6789b18a08a22..1e5556dd1b864109985d5871616ae6b9164bcead 2023-06-29 07:34:47 UTC to 2023-06-27 23:43:06 UTC - add constgebra to list of math crates (rust-embedded/book#358) - Switch to GHMQ (rust-embedded/book#357) ## rust-lang/nomicon 1 commits in c369e4b489332f8721fbae630354fa83385d457d..302b995bcb24b70fd883980fd174738c3a10b705 2023-07-05 16:08:32 UTC to 2023-07-05 16:08:32 UTC - Minor improvements (rust-lang/nomicon#414) ## rust-lang/reference 5 commits in 5ca365eac678cb0d41a20b3204546d6ed70c7171..1ea0178266b3f3f613b0fabdaf16a83961c99cdb 2023-07-08 22:11:07 UTC to 2023-06-26 16:51:55 UTC - Remove doc of unstable feature of never type (rust-lang/reference#1376) - Typo: 'assingee' to 'assignee' in expressions.md (rust-lang/reference#1377) - str type: make sentence more readable (rust-lang/reference#1374) - Remove obsolete note about soundness hole in type-layout.md (rust-lang/reference#1367) - Typo: 'a' to 'an' in destructors.md (rust-lang/reference#1371) ## rust-lang/rust-by-example 1 commits in 57636d6926762861f34e030d52ca25a71e95e5bf..8a87926a985ce32ca1fad1be4008ee161a0b91eb 2023-07-07 22:44:06 UTC to 2023-07-07 22:44:06 UTC - Hint for RGB color calculation (rust-lang/rust-by-example#1726) ## rust-lang/rustc-dev-guide 18 commits in 17fe3e948498c50e208047a750f17d6a8d89669b..b5a12d95e32ae53791cc6ab44417774667ed2ac6 2023-07-09 14:50:50 UTC to 2023-06-28 04:55:24 UTC - fix: update link to function coverage (rust-lang/rustc-dev-guide#1727) - Fix a bug in getting-started.md (rust-lang/rustc-dev-guide#1726) - improve explanation of placing tests in separate file (rust-lang/rustc-dev-guide#1721) - various fixes/improvements to Contributing chapter (rust-lang/rustc-dev-guide#1723) - ty::ConstKind has moved (rust-lang/rustc-dev-guide#1724) - document `./x test --rustc-args` option (rust-lang/rustc-dev-guide#1719) - tests/run-make files have moved (rust-lang/rustc-dev-guide#1716) - replace dead link (rust-lang/rustc-dev-guide#1717) - fix link (rust-lang/rustc-dev-guide#1718) - update link (rust-lang/rustc-dev-guide#1709) - typo (rust-lang/rustc-dev-guide#1706) - OwningRef exists no more (rust-lang/rustc-dev-guide#1715) - Try to avoid confusion (rust-lang/rustc-dev-guide#1713) - Issue1707 doc simply use x (rust-lang/rustc-dev-guide#1710) - include rustc-dev-guide's own issues in suggested search (rust-lang/rustc-dev-guide#1708) - Improve feature gate and x.py docs (rust-lang/rustc-dev-guide#1701) - Fix some links (rust-lang/rustc-dev-guide#1705) - Define more lint terms. (rust-lang/rustc-dev-guide#1681)

sslime336 added 3 commits July 1, 2023 00:43

Change ./x.py into ./x

7b7dccb

Change x.py into x, add explanation for x

a1ca3d3

Fix line length out of limit

4083247

tshepang reviewed Jun 30, 2023

View reviewed changes

src/building/how-to-build-and-run.md Outdated Show resolved Hide resolved

typo

f1db302

tshepang approved these changes Jun 30, 2023

View reviewed changes

tshepang merged commit 8648005 into rust-lang:master Jun 30, 2023
1 check passed

sslime336 deleted the issue1701-doc-simply-use-x branch July 1, 2023 02:01

JohnTitor mentioned this pull request Jul 1, 2023

Use ./x instead of ./x.py in documentation #1707

Closed

jyn514 reviewed Jul 1, 2023

View reviewed changes

sslime336 restored the issue1701-doc-simply-use-x branch July 1, 2023 04:55

sslime336 deleted the issue1701-doc-simply-use-x branch July 1, 2023 04:58

sslime336 changed the title ~~Issue1701 doc simply use x~~ Issue1707 doc simply use x Jul 1, 2023

This was referenced Jul 1, 2023

Try to avoid confusion in how-to-build-and-run.md #1712

Closed

Try to avoid confusion #1713

Merged

rustbot mentioned this pull request Jul 10, 2023

Update books rust-lang/rust#113548

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue1707 doc simply use x #1710

Issue1707 doc simply use x #1710

sslime336 commented Jun 30, 2023 •

edited

Loading

jyn514 Jul 1, 2023

sslime336 Jul 1, 2023

Issue1707 doc simply use x #1710

Issue1707 doc simply use x #1710

Conversation

sslime336 commented Jun 30, 2023 • edited Loading

jyn514 Jul 1, 2023

Choose a reason for hiding this comment

sslime336 Jul 1, 2023

Choose a reason for hiding this comment

sslime336 commented Jun 30, 2023 •

edited

Loading