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

winbuild/README: document how to clean a build #15291

Closed
wants to merge 1 commit into from

Conversation

jay
Copy link
Member

@jay jay commented Oct 14, 2024

  • Add a new section explaining that a build can be cleaned by adding the keyword "clean" to the build command.

  • Add an example of using the "x64 Native Tools" prompt to the VS command prompt section.

  • Update the Legacy Windows section's lack-of-cipher support warning to say "Windows 8 and earlier" instead of "Windows XP and earlier."

Ref: #15277

Closes #xxxx

@jay jay added documentation Windows Windows-specific labels Oct 14, 2024
@github-actions github-actions bot added the build label Oct 14, 2024
@jay
Copy link
Member Author

jay commented Oct 14, 2024

The prose error due to many warnings appears to be unrelated:

Run git ls-files -z '*.md' | grep -Evz 'CHECKSRC.md|DISTROS.md|CURLOPT_INTERFACE.md|interface.md' | xargs -0 proselint README
:0: DeprecationWarning: /home/runner/.proselintrc was found instead of a JSON file. Rename to /home/runner/.proselintrc.json.
.github/CONTRIBUTING.md:29:16: leonard.exclamation.30ppm More than 30 ppm of exclamations. Keep them under control.
README.md:6[4](https://github.com/curl/curl/actions/runs/11324046183/job/31488018996?pr=15291#step:6:5):29: leonard.exclamation.30ppm More than 30 ppm of exclamations. Keep them under control.
docs/CIPHERS.md:62:17: leonard.exclamation.30ppm More than 30 ppm of exclamations. Keep them under control.
docs/ECH.md:333:7[5](https://github.com/curl/curl/actions/runs/11324046183/job/31488018996?pr=15291#step:6:6): leonard.exclamation.30ppm More than 30 ppm of exclamations. Keep them under control.
docs/HTTP3.md:249:17: lexical_illusions.misc There's a lexical illusion here: a word is repeated.
docs/INSTALL.md:573:52: leonard.exclamation.30ppm More than 30 ppm of exclamations. Keep them under control.
docs/MAIL-ETIQUETTE.md:235:34: lexical_illusions.misc There's a lexical illusion here: a word is repeated.
docs/MANUAL.md:2[7](https://github.com/curl/curl/actions/runs/11324046183/job/31488018996?pr=15291#step:6:8)7:13: lexical_illusions.misc There's a lexical illusion here: a word is repeated.
...

- Add a new section explaining that a build can be cleaned by adding the
  keyword "clean" to the build command.

- Add an example of using the "x64 Native Tools" prompt to the VS
  command prompt section.

- Update the Legacy Windows section's lack-of-cipher support warning to
  say "Windows 8 and earlier" instead of "Windows XP and earlier."

Ref: curl#15277

Closes #xxxx
@vszakats
Copy link
Member

The prose error due to many warnings appears to be unrelated:

Trying to address some of them in #15293.

vszakats added a commit that referenced this pull request Oct 15, 2024
Fix new issues found by `proselint`.

Also:
- silence this technical warning:
  ```
  :0: DeprecationWarning: /home/runner/.proselintrc was found instead of a JSON file. Rename to /home/runner/.proselintrc.json.
  ```
- fix an input filename.
  `proselints` fails now if an input file is missing.

Reported-by: Jay Satiro
Bug: #15291 (comment)
Closes #15293
@jay jay closed this in fde5326 Oct 16, 2024
@jay jay deleted the update_winbuild_README branch October 16, 2024 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

3 participants