Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

[skip changelog] Use relative links for documentation pages #799

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

Merged
per1234 merged 1 commit into arduino:master from per1234:relative-docs-links
Jul 8, 2020
Merged

[skip changelog] Use relative links for documentation pages #799

per1234 merged 1 commit into arduino:master from per1234:relative-docs-links
Jul 8, 2020

Conversation

Copy link
Contributor

@per1234 per1234 commented Jul 8, 2020 •
edited
Loading

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • The PR follows our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce?

Documentation fix.

  • What is the current behavior?

The documentation contains absolute links to internal pages. Now that the documentation system uses versioning, these links can cause the reader to experience an unexpected change in the version of the documentation they are browsing.

  • What is the new behavior?

All links to internal documentation pages are relative.

  • Does this PR introduce a breaking change?

No.

 

Now that the documentation system uses versioning, absolute links can cause the reader to experience an unexpected change in the documentation version being viewed.
@per1234 per1234 added the topic: documentation Related to documentation for the project label Jul 8, 2020
@per1234 per1234 merged commit 2040dca into arduino:master Jul 8, 2020
@per1234 per1234 deleted the relative-docs-links branch July 8, 2020 21:19
* rev.2.2 will be implemented starting from version Arduino IDE 1.8.10

This new library format is intended to be used in tandem with **Library Manager**, available since Arduino IDE 1.6.2. The Library Manager allows users to automatically download and install libraries needed in their projects, with an easy to use graphic interface in the [Arduino IDE](https://www.arduino.cc/en/guide/libraries#toc3)/Pro IDE and [Arduino Web Editor](https://create.arduino.cc/projecthub/Arduino_Genuino/getting-started-with-arduino-web-editor-on-various-platforms-4b3e4a#toc-libraries-and-the-arduino-web-editor-11) as well as [`arduino-cli lib`](https://arduino.github.io/arduino-cli/commands/arduino-cli_lib/).
This new library format is intended to be used in tandem with **Library Manager**, available since Arduino IDE 1.6.2. The Library Manager allows users to automatically download and install libraries needed in their projects, with an easy to use graphic interface in the [Arduino IDE](https://www.arduino.cc/en/guide/libraries#toc3)/Pro IDE and [Arduino Web Editor](https://create.arduino.cc/projecthub/Arduino_Genuino/getting-started-with-arduino-web-editor-on-various-platforms-4b3e4a#toc-libraries-and-the-arduino-web-editor-11) as well as [`arduino-cli lib`](../commands/arduino-cli_lib).
Copy link

@ubidefeo ubidefeo Jul 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"graphic user interface"

Arduino CLI and Arduino Web Editor use a file named sketch.json, located in the sketch root folder, to store sketch metadata.

The `cpu` key contains the board configuration information. This can be set via [`arduino-cli board attach`](https://arduino.github.io/arduino-cli/commands/arduino-cli_board_attach/) or by selecting a board in the Arduino Web Editor while the sketch is open. With this configuration set, it is not necessary to specify the `--fqbn` or `--port` flags to the [`arduino-cli compile`](https://arduino.github.io/arduino-cli/commands/arduino-cli_compile/) or [`arduino-cli upload`](https://arduino.github.io/arduino-cli/commands/arduino-cli_upload/) commands when compiling or uploading the sketch.
The `cpu` key contains the board configuration information. This can be set via [`arduino-cli board attach`](../commands/arduino-cli_board_attach/) or by selecting a board in the Arduino Web Editor while the sketch is open. With this configuration set, it is not necessary to specify the `--fqbn` or `--port` flags to the [`arduino-cli compile`](../commands/arduino-cli_compile/) or [`arduino-cli upload`](../commands/arduino-cli_upload/) commands when compiling or uploading the sketch.
Copy link

@ubidefeo ubidefeo Jul 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this generates confusion.
why would selecting the cpu option remove requirement for the port option?

Copy link
Contributor Author

@per1234 per1234 Jul 9, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cpu is not really an great name for the key. Something like "board" would have been better.

If I run this command:

arduino-cli board attach serial:///dev/ttyACM0 HelloWorld

It writes a sketch.json sketch metadata file to the HelloWorld sketch that looks something like:

{
 "cpu": {
 "fqbn": "arduino:avr:mega",
 "name": "Arduino Mega or Mega 2560",
 "port": "serial:///dev/ttyACM0"
 }
}

So now if I don't specify a --port option when running an arduino-cli command with the HelloWorld sketch, the cpu.port value from sketch.json is automatically used.

Copy link

@ubidefeo ubidefeo Jul 9, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be board or target rather than cpu
@rsora @cmaglie , care to chime in on this small debate?

@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ubidefeo ubidefeo ubidefeo left review comments

+1 more reviewer

@rsora rsora rsora approved these changes

Reviewers whose approvals may not affect merge requirements
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /