From 61ea262ddc02eaf78cd4c4a96a4c5c0a640bc1e8 Mon Sep 17 00:00:00 2001 From: Yannick Moy Date: Thu, 6 Jun 2024 17:19:10 +0200 Subject: [PATCH] Fix typos and hyperlinks in doc --- doc/getting-started.md | 11 ++++++----- doc/publishing.md | 20 ++++++++++---------- doc/toolchains.md | 7 ++++--- 3 files changed, 20 insertions(+), 18 deletions(-) diff --git a/doc/getting-started.md b/doc/getting-started.md index 3044bdc6..40b2441c 100644 --- a/doc/getting-started.md +++ b/doc/getting-started.md @@ -289,12 +289,12 @@ enough to get an idea of the root of the problem. Additionally, `-d` will show tracebacks of exceptions. Subprocess output is shown by default (you can silence it, and anything else -not an error) with `-q`, which enables quiet mode. Any subprocess that exist +not an error) with `-q`, which enables quiet mode. Any subprocess that exits abnormally will be reported, including its invocation arguments. If you suspect your settings may be the source of some problem, please check -our section on [Settings](setting), and in particular how to use a [default -pristine settings](settings#Relocating-your-settings) +our section on [Settings](settings), and in particular how to use a [default +pristine settings](settings#relocating-your-settings) ## Running tests @@ -393,8 +393,9 @@ you have to add a project-files = ["project_file.gpr"] ``` -Although this is not recommended (see Best practices), you can have multiple -GPR project files: +Although this is not recommended (see +[best practices](policies#best-practices)), you can have multiple GPR project files: + ```toml project-files = ["project_file_1.gpr", "project_file_2.gpr"] ``` diff --git a/doc/publishing.md b/doc/publishing.md index 108f7346..b44d2e56 100644 --- a/doc/publishing.md +++ b/doc/publishing.md @@ -22,7 +22,7 @@ index on GitHub on your behalf. Read on for the details underlying these automated steps, or in case you need to perform further tweaking. -## Creating a Github Personal Access Token +## Creating a GitHub Personal Access Token A Personal Access Token (PAT) allows Alire to act on your behalf to fork the community index, push the new release manifest to a new branch in your own fork, @@ -31,7 +31,7 @@ and finally open a pull-request against the community repository. The PAT, once created, is a plain string. You can either export the environment variable `GH_TOKEN` set to this string, or provide it when Alire asks for it. -There are two kinds of PATs on Github: classic and fine-grained. The latter are +There are two kinds of PATs on GitHub: classic and fine-grained. The latter are in beta and not documented here yet. Follow these steps to create a classic PAT: 1. On the main https://github.com page, after having logged in, click on your @@ -112,20 +112,20 @@ methods to prepare your release submission: For this common use case, you need: -- A git repository that is clean an up-to-date with its remote. +- A git repository that is clean and up-to-date with its remote. - The repository already contains the release you want to publish. - The commit with the release must exist both locally and at the remote. - The repository must also be an Alire-enabled workspace: - It contains a top-level `alire.toml` manifest describing the release. - The remote host must be one of a few trusted major open-source sites. - This requirement is motivated by vulnerabilities identified with SHA1, - whose migration to a stronger hash is [not yet complete] - (https://git-scm.com/docs/hash-function-transition/) in `git`. + whose migration to a stronger hash is + [not yet complete](https://git-scm.com/docs/hash-function-transition/) in `git`. - `alr` will inform you if your host is not supported. Please contact us if you think a site should be allowed. The complete list can be consulted by running `alr publish --trusted-sites`. - This is a temporary measure until more sophisticated publishing automation - is supported. See the [Remote Source Archive](#remote-source-archive) case + is supported. See the [Starting with a remote source archive](#starting-with-a-remote-source-archive) case for alternatives to this scenario (you are not forced to change your code hosting, or even have an online repository). @@ -153,7 +153,7 @@ offer to create the pull request for you, unless you specify `--skip-submit`. If so, a link for conveniently creating this PR will also be provided by `alr`: - Upload the generated index manifest file (`crate-version.toml`) to the - supplied page link on github and create a pull-request. + supplied page link on GitHub and create a pull-request. ### Starting with a remote repository, without local clone @@ -217,7 +217,7 @@ must be manually uploaded by the user to a publicly accessible hosting service. After the upload, the user can supply the URL to fetch this archive to the publishing assistant (which will be waiting for this information), and the assistant will resume as if it had been invoked with `alr publish ` -(see #starting-with-a-remote-source-archive). +(see [Starting with a remote source archive](#starting-with-a-remote-source-archive)). ### Support for complex projects whose sources become multiple Alire crates @@ -261,8 +261,8 @@ workflows. ### Creating the PR via cloning. -Instead of uploading the generated index manifest file via the github upload -link, you can follow the usual procedure to submit a PR to a github repository: +Instead of uploading the generated index manifest file via the GitHub upload +link, you can follow the usual procedure to submit a PR to a GitHub repository: 1. Fork the community index to your GitHub account. 1. Clone your fork locally and place generated manifest at the intended folder. diff --git a/doc/toolchains.md b/doc/toolchains.md index 2ab1e35c..f0c3aef9 100644 --- a/doc/toolchains.md +++ b/doc/toolchains.md @@ -8,7 +8,7 @@ The user can now select a preferred compiler via `alr toolchain --select`. Releases may still override this selection (for example to use a cross-compiler). -There are two kind of dependencies on GNAT compilers: generic dependencies on +There are two kinds of dependencies on GNAT compilers: generic dependencies on the `gnat` crate, which apply to every compiler, and dependencies on a precise native or cross-compiler. @@ -19,8 +19,9 @@ the host platform. ## Identifying available compilers -Compilers available for download can be listed with `alr search --full ---external-detect gnat_`. They will also be shown by the selection assistant, +Compilers available for download can be listed with +`alr search --full --external-detect gnat_`. +They will also be shown by the selection assistant, `alr toolchain --select`. Running `alr toolchain` without arguments will show the installed compilers and -- 2.39.5