diff --git a/docs/ide/qtcreator.rst b/docs/ide/qtcreator.rst index 714d10c7..a40f910a 100644 --- a/docs/ide/qtcreator.rst +++ b/docs/ide/qtcreator.rst @@ -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. -.. code-block:: none +.. code-block:: ini - # - # PlatformIO Project Configuration File - # - # Please make sure to read documentation with examples first - # http://docs.platformio.org/en/stable/projectconf.html - # + ; PlatformIO Project Configuration File + ; + ; Build options: build flags, source filter, extra scripting + ; Upload options: custom port, speed and extra flags + ; 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] platform = atmelavr diff --git a/docs/ide/sublimetext.rst b/docs/ide/sublimetext.rst index 7e58b2fc..3342f5d4 100644 --- a/docs/ide/sublimetext.rst +++ b/docs/ide/sublimetext.rst @@ -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. Copy the source code which is described below to it. -.. code-block:: none +.. code-block:: ini - # - # PlatformIO Project Configuration File - # - # Please make sure to read documentation with examples first - # http://docs.platformio.org/en/stable/projectconf.html - # + ; PlatformIO Project Configuration File + ; + ; Build options: build flags, source filter, extra scripting + ; Upload options: custom port, speed and extra flags + ; 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] platform = atmelavr diff --git a/docs/ide/visualstudio.rst b/docs/ide/visualstudio.rst index 46323421..ae58d2f5 100644 --- a/docs/ide/visualstudio.rst +++ b/docs/ide/visualstudio.rst @@ -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. -.. code-block:: none +.. code-block:: ini - # - # PlatformIO Project Configuration File - # - # Please make sure to read documentation with examples first - # http://docs.platformio.org/en/stable/projectconf.html - # + ; PlatformIO Project Configuration File + ; + ; Build options: build flags, source filter, extra scripting + ; Upload options: custom port, speed and extra flags + ; 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] platform = atmelavr diff --git a/docs/platforms/atmelavr_extra.rst b/docs/platforms/atmelavr_extra.rst index 7d97a4d8..ac6691bd 100644 --- a/docs/platforms/atmelavr_extra.rst +++ b/docs/platforms/atmelavr_extra.rst @@ -30,7 +30,7 @@ Configuration for the programmers: upload_protocol = stk500v1 upload_flags = -P$UPLOAD_PORT - # edit this line with valid upload port + ; edit this line with valid upload port upload_port = SERIAL_PORT_HERE * AVRISP mkII @@ -91,7 +91,7 @@ Configuration for the programmers: upload_protocol = stk500v1 upload_flags = -P$UPLOAD_PORT -b$UPLOAD_SPEED - # edit these lines + ; edit these lines upload_port = SERIAL_PORT_HERE upload_speed = 19200 diff --git a/docs/platforms/espressif_extra.rst b/docs/platforms/espressif_extra.rst index b6315b4e..16d0343e 100644 --- a/docs/platforms/espressif_extra.rst +++ b/docs/platforms/espressif_extra.rst @@ -17,7 +17,7 @@ See :ref:`projectconf_board_f_cpu` option from :ref:`projectconf` .. code-block:: ini [env:myenv] - # set frequency to 160MHz + ; set frequency to 160MHz board_f_cpu = 160000000L Custom FLASH Frequency @@ -34,7 +34,7 @@ values: .. code-block:: ini [env:myenv] - # set frequency to 80MHz + ; set frequency to 80MHz board_f_flash = 80000000L Custom FLASH Mode diff --git a/docs/projectconf.rst b/docs/projectconf.rst index d0cb2468..dab41cb4 100644 --- a/docs/projectconf.rst +++ b/docs/projectconf.rst @@ -440,7 +440,7 @@ Example: build_flags = -Wl,-T/path/to/ld_script.ld [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) @@ -569,7 +569,7 @@ The list with available targets is located in :option:`platformio run --target`. # clean project platformio run -t clean - # dump curent build environment + # dump current build environment platformio run --target envdump When no targets are defined, *PlatformIO* will build only sources by default. @@ -806,7 +806,7 @@ Examples framework = arduino board = uno - # enable auto-uploading + ; enable auto-uploading targets = upload @@ -821,12 +821,12 @@ Examples board_f_cpu = 16000000L upload_port = /dev/ttyUSB0 - # for Windows OS - # upload_port = COM3 + ; for Windows OS + ; upload_port = COM3 upload_protocol = arduino upload_speed = 19200 - # enable auto-uploading + ; enable auto-uploading targets = upload diff --git a/docs/quickstart.rst b/docs/quickstart.rst index f6d8600b..c3e61cfa 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -145,12 +145,14 @@ The result of just generated ``platformio.ini``: .. code-block:: ini - # - # PlatformIO Project Configuration File - # - # Please make sure to read documentation with examples first - # http://docs.platformio.org/en/stable/projectconf.html - # + ; PlatformIO Project Configuration File + ; + ; Build options: build flags, source filter, extra scripting + ; Upload options: custom port, speed and extra flags + ; 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] platform = atmelavr diff --git a/examples b/examples index 8f196b57..3cc5a6cf 160000 --- a/examples +++ b/examples @@ -1 +1 @@ -Subproject commit 8f196b57cb3e6ea94868b406e501da1888b24ea9 +Subproject commit 3cc5a6cf883343b41917d036a8673606dfabd945 diff --git a/platformio/projectconftpl.ini b/platformio/projectconftpl.ini index c4b4ae30..fa77ae29 100644 --- a/platformio/projectconftpl.ini +++ b/platformio/projectconftpl.ini @@ -1,10 +1,8 @@ -# -# PlatformIO Project Configuration File -# -# Build options: build flags, source filter, extra scripting -# Upload options: custom port, speed and extra flags -# Library options: dependencies, extra library storages -# -# Please visit documentation for the other options and examples -# http://docs.platformio.org/en/stable/projectconf.html -# +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter, extra scripting +; Upload options: custom port, speed and extra flags +; Library options: dependencies, extra library storages +; +; Please visit documentation for the other options and examples +; http://docs.platformio.org/en/stable/projectconf.html