Skip to content

Commit db55511

Browse files
committed
Use supported line break markup
The backslash at end of line to cause line break is not supported by the documentation build system.
1 parent c2f599e commit db55511

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

docs/package_index_json-specification.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ Each tool version may come in different build flavours for different OS. Each fl
134134
* Windows (`i686-mingw32`),
135135
* Mac (`i386-apple-darwin11`)
136136

137-
The IDE will take care to install the right flavour based on the `host` value, or fail if a needed flavour is missing. \
137+
The IDE will take care to install the right flavour based on the `host` value, or fail if a needed flavour is missing.<br>
138138
Note that the IDE does not use this information to select the toolchain during verify. If you want the IDE to use this specific version you should use the notation {runtime.tools.TOOLNAME-VERSION.path} in the platform.txt.
139139

140140
The other fields are:

docs/platform-specification.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
This specification is a 3rd party Hardware format to be used in Arduino IDE starting from 1.5.x series. \
2-
This specification allows a 3rd party vendor/maintainer to add support for new boards inside the Arduino IDE by providing a file to unzip into the *hardware* folder of Arduino's sketchbook folder. \
1+
This specification is a 3rd party Hardware format to be used in Arduino IDE starting from 1.5.x series.<br>
2+
This specification allows a 3rd party vendor/maintainer to add support for new boards inside the Arduino IDE by providing a file to unzip into the *hardware* folder of Arduino's sketchbook folder.<br>
33
It is also possible to add new 3rd party boards by providing just one configuration file.
44

55
## Hardware Folders structure
@@ -78,7 +78,7 @@ The following meta-data must be defined:
7878
name=Arduino AVR Boards
7979
version=1.5.3
8080

81-
The **name** will be shown in the Boards menu of the Arduino IDE. \
81+
The **name** will be shown in the Boards menu of the Arduino IDE.<br>
8282
The **version** is currently unused, it is reserved for future use (probably together with the libraries manager to handle dependencies on cores).
8383

8484
### Build process
@@ -356,7 +356,7 @@ instead, the Arduino Leonardo board needs the *leonardo* variant:
356356
leonardo.build.variant=leonardo
357357
[.....]
358358

359-
In the example above, both Uno and Leonardo share the same core but use different variants. \
359+
In the example above, both Uno and Leonardo share the same core but use different variants.<br>
360360
In any case, the contents of the selected variant folder path is added to the include search path and its contents are compiled and linked with the sketch.
361361

362362
The parameter **build.variant.path** is automatically found by the IDE.
@@ -385,7 +385,7 @@ Each action has its own recipe and its configuration is done through a set of pr
385385
tools.avrdude.bootloader.pattern=[......]
386386
[.....]
387387

388-
A tool may have some actions not defined (it's not mandatory to define all four actions). \
388+
A tool may have some actions not defined (it's not mandatory to define all four actions).<br>
389389
Let's look at how the **upload** action is defined for avrdude:
390390

391391
tools.avrdude.path={runtime.tools.avrdude.path}
@@ -400,7 +400,7 @@ The Arduino IDE makes the tool configuration properties available globally witho
400400

401401
#### Verbose parameter
402402

403-
It is possible for the user to enable verbosity from the Arduino IDE's Preferences panel. This preference is transferred to the command line by the IDE using the **ACTION.verbose** property (where ACTION is the action we are considering). \
403+
It is possible for the user to enable verbosity from the Arduino IDE's Preferences panel. This preference is transferred to the command line by the IDE using the **ACTION.verbose** property (where ACTION is the action we are considering).<br>
404404
When the verbose mode is enabled the **tools.TOOL_ID.ACTION.params.verbose** property is copied into **ACTION.verbose**. When the verbose mode is disabled, the **tools.TOOL_ID.ACTION.params.quiet** property is copied into **ACTION.verbose**. Confused? Maybe an example will clear things:
405405

406406
tools.avrdude.upload.params.verbose=-v -v -v -v
@@ -480,7 +480,7 @@ The platform.txt associated with the selected board will be used.
480480
The Arduino IDE allows adding extra menu items under the Tools menu. With these sub-menus the user can select different configurations for a specific board (for example a board could be provided in two or more variants with different CPUs, or may have different crystal speed based on the board model, and so on...).
481481

482482
Let's see an example of how a custom menu is implemented.
483-
The board used in the example is the Arduino Duemilanove. This board was produced in two models, one with an ATmega168 CPU and another with an ATmega328P. \
483+
The board used in the example is the Arduino Duemilanove. This board was produced in two models, one with an ATmega168 CPU and another with an ATmega328P.<br>
484484
We are going then to define a custom menu "Processor" that allows the user to choose between the two
485485
different microcontrollers.
486486

@@ -489,7 +489,7 @@ We must first define a set of **menu.MENU_ID=Text** properties. Text is what is
489489
menu.cpu=Processor
490490
[.....]
491491

492-
in this case we declare only one custom menu "Processor" which we refer using the "cpu" MENU_ID. \
492+
in this case we declare only one custom menu "Processor" which we refer using the "cpu" MENU_ID.<br>
493493
Now let's add, always in the boards.txt file, the default configuration (common to all processors) for the duemilanove board:
494494

495495
menu.cpu=Processor
@@ -511,8 +511,8 @@ Now let's define the options to show in the "Processor" menu:
511511
duemilanove.menu.cpu.atmega168=ATmega168
512512
[.....]
513513

514-
We have defined two options: "ATmega328P" and "ATmega168". \
515-
Note that the property keys must follow the format **BOARD_ID.menu.MENU_ID.OPTION_ID=Text**. \
514+
We have defined two options: "ATmega328P" and "ATmega168".<br>
515+
Note that the property keys must follow the format **BOARD_ID.menu.MENU_ID.OPTION_ID=Text**.<br>
516516
Finally, the specific configuration for every option:
517517

518518
[.....]

0 commit comments

Comments
 (0)