platformio/platformio-core
1
0
Fork 1
mirror of https://github.com/platformio/platformio-core.git synced 2025-07-30 01:57:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Use semicolons for comment in INI File

Browse Source
This commit is contained in:
Ivan Kravets
2016-08-09 16:53:51 +03:00
parent 55c1a90fc9
commit bda61d0ae2
9 changed files with 54 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/ide/qtcreator.rst
View File

@ -165,14 +165,16 @@ Copy the source code which is described below to file ``main.c``.
Edit the content to match the code described below. Edit the content to match the code described below.
.. code-block:: none .. code-block:: ini
# ; PlatformIO Project Configuration File
# PlatformIO Project Configuration File ;
# ; Build options: build flags, source filter, extra scripting
# Please make sure to read documentation with examples first ; Upload options: custom port, speed and extra flags
# http://docs.platformio.org/en/stable/projectconf.html ; Library options: dependencies, extra library storages
# ;
; Please visit documentation for the other options and examples
; http://docs.platformio.org/en/stable/projectconf.html
[env:arduino_uno] [env:arduino_uno]
platform = atmelavr platform = atmelavr

16
docs/ide/sublimetext.rst
View File

@ -164,14 +164,16 @@ Let's create new file named ``main.c`` using ``Menu: File > New File`` or shortc
2. Project Configuration File named ``platformio.ini`` must be located in the project root directory. 2. Project Configuration File named ``platformio.ini`` must be located in the project root directory.
Copy the source code which is described below to it. Copy the source code which is described below to it.
.. code-block:: none .. code-block:: ini
# ; PlatformIO Project Configuration File
# PlatformIO Project Configuration File ;
# ; Build options: build flags, source filter, extra scripting
# Please make sure to read documentation with examples first ; Upload options: custom port, speed and extra flags
# http://docs.platformio.org/en/stable/projectconf.html ; Library options: dependencies, extra library storages
# ;
; Please visit documentation for the other options and examples
; http://docs.platformio.org/en/stable/projectconf.html
[env:arduino_uno] [env:arduino_uno]
platform = atmelavr platform = atmelavr

16
docs/ide/visualstudio.rst
View File

@ -124,14 +124,16 @@ Copy the source code which is described below to file ``main.cpp``.
Copy the source code which is described below to it. Copy the source code which is described below to it.
.. code-block:: none .. code-block:: ini
# ; PlatformIO Project Configuration File
# PlatformIO Project Configuration File ;
# ; Build options: build flags, source filter, extra scripting
# Please make sure to read documentation with examples first ; Upload options: custom port, speed and extra flags
# http://docs.platformio.org/en/stable/projectconf.html ; Library options: dependencies, extra library storages
# ;
; Please visit documentation for the other options and examples
; http://docs.platformio.org/en/stable/projectconf.html
[env:arduino_uno] [env:arduino_uno]
platform = atmelavr platform = atmelavr

4
docs/platforms/atmelavr_extra.rst
View File

@ -30,7 +30,7 @@ Configuration for the programmers:
upload_protocol = stk500v1 upload_protocol = stk500v1
upload_flags = -P$UPLOAD_PORT upload_flags = -P$UPLOAD_PORT
# edit this line with valid upload port ; edit this line with valid upload port
upload_port = SERIAL_PORT_HERE upload_port = SERIAL_PORT_HERE
* AVRISP mkII * AVRISP mkII
@ -91,7 +91,7 @@ Configuration for the programmers:
upload_protocol = stk500v1 upload_protocol = stk500v1
upload_flags = -P$UPLOAD_PORT -b$UPLOAD_SPEED upload_flags = -P$UPLOAD_PORT -b$UPLOAD_SPEED
# edit these lines ; edit these lines
upload_port = SERIAL_PORT_HERE upload_port = SERIAL_PORT_HERE
upload_speed = 19200 upload_speed = 19200

4
docs/platforms/espressif_extra.rst
View File

@ -17,7 +17,7 @@ See :ref:`projectconf_board_f_cpu` option from :ref:`projectconf`
.. code-block:: ini .. code-block:: ini
[env:myenv] [env:myenv]
# set frequency to 160MHz ; set frequency to 160MHz
board_f_cpu = 160000000L board_f_cpu = 160000000L
Custom FLASH Frequency Custom FLASH Frequency
@ -34,7 +34,7 @@ values:
.. code-block:: ini .. code-block:: ini
[env:myenv] [env:myenv]
# set frequency to 80MHz ; set frequency to 80MHz
board_f_flash = 80000000L board_f_flash = 80000000L
Custom FLASH Mode Custom FLASH Mode

12
docs/projectconf.rst
View File

@ -440,7 +440,7 @@ Example:
build_flags = -Wl,-T/path/to/ld_script.ld build_flags = -Wl,-T/path/to/ld_script.ld
[env:exec_command] [env:exec_command]
# get VCS revision "on-the-fly" ; get VCS revision "on-the-fly"
build_flags = !echo "-DPIO_SRC_REV="$(git rev-parse HEAD) build_flags = !echo "-DPIO_SRC_REV="$(git rev-parse HEAD)
@ -569,7 +569,7 @@ The list with available targets is located in :option:`platformio run --target`.
# clean project # clean project
platformio run -t clean platformio run -t clean
# dump curent build environment # dump current build environment
platformio run --target envdump platformio run --target envdump
When no targets are defined, *PlatformIO* will build only sources by default. When no targets are defined, *PlatformIO* will build only sources by default.
@ -806,7 +806,7 @@ Examples
framework = arduino framework = arduino
board = uno board = uno
# enable auto-uploading ; enable auto-uploading
targets = upload targets = upload
@ -821,12 +821,12 @@ Examples
board_f_cpu = 16000000L board_f_cpu = 16000000L
upload_port = /dev/ttyUSB0 upload_port = /dev/ttyUSB0
# for Windows OS ; for Windows OS
# upload_port = COM3 ; upload_port = COM3
upload_protocol = arduino upload_protocol = arduino
upload_speed = 19200 upload_speed = 19200
# enable auto-uploading ; enable auto-uploading
targets = upload targets = upload

14
docs/quickstart.rst
View File

@ -145,12 +145,14 @@ The result of just generated ``platformio.ini``:
.. code-block:: ini .. code-block:: ini
# ; PlatformIO Project Configuration File
# PlatformIO Project Configuration File ;
# ; Build options: build flags, source filter, extra scripting
# Please make sure to read documentation with examples first ; Upload options: custom port, speed and extra flags
# http://docs.platformio.org/en/stable/projectconf.html ; Library options: dependencies, extra library storages
# ;
; Please visit documentation for the other options and examples
; http://docs.platformio.org/en/stable/projectconf.html
[env:uno] [env:uno]
platform = atmelavr platform = atmelavr

2
examples

Submodule examples updated: 8f196b57cb...3cc5a6cf88

18
platformio/projectconftpl.ini
View File

@ -1,10 +1,8 @@
# ; PlatformIO Project Configuration File
# PlatformIO Project Configuration File ;
# ; Build options: build flags, source filter, extra scripting
# Build options: build flags, source filter, extra scripting ; Upload options: custom port, speed and extra flags
# Upload options: custom port, speed and extra flags ; Library options: dependencies, extra library storages
# Library options: dependencies, extra library storages ;
# ; Please visit documentation for the other options and examples
# Please visit documentation for the other options and examples ; http://docs.platformio.org/en/stable/projectconf.html
# http://docs.platformio.org/en/stable/projectconf.html
#