mirror of
https://github.com/platformio/platformio-core.git
synced 2025-07-30 01:57:13 +02:00
Switch docs to HTTPS
This commit is contained in:
520
HISTORY.rst
520
HISTORY.rst
File diff suppressed because it is too large
Load Diff
22
README.rst
22
README.rst
@ -24,7 +24,7 @@ PlatformIO
|
|||||||
`PIO Plus <https://platformio.org/pricing?utm_source=github&utm_medium=core>`_ |
|
`PIO Plus <https://platformio.org/pricing?utm_source=github&utm_medium=core>`_ |
|
||||||
`PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=github&utm_medium=core>`_ |
|
`PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=github&utm_medium=core>`_ |
|
||||||
`Project Examples <https://github.com/platformio/platformio-examples/>`_ |
|
`Project Examples <https://github.com/platformio/platformio-examples/>`_ |
|
||||||
`Docs <http://docs.platformio.org?utm_source=github&utm_medium=core>`_ |
|
`Docs <https://docs.platformio.org?utm_source=github&utm_medium=core>`_ |
|
||||||
`Donate <https://platformio.org/donate?utm_source=github&utm_medium=core>`_ |
|
`Donate <https://platformio.org/donate?utm_source=github&utm_medium=core>`_ |
|
||||||
`Contact Us <https://platformio.org/contact?utm_source=github&utm_medium=core>`_
|
`Contact Us <https://platformio.org/contact?utm_source=github&utm_medium=core>`_
|
||||||
|
|
||||||
@ -45,26 +45,26 @@ firmware updates.
|
|||||||
Get Started
|
Get Started
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
* `What is PlatformIO? <http://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=github&utm_medium=core>`_
|
* `What is PlatformIO? <https://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=github&utm_medium=core>`_
|
||||||
|
|
||||||
Open Source
|
Open Source
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
* `PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=github&utm_medium=core>`_
|
* `PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=github&utm_medium=core>`_
|
||||||
* `PlatformIO Core (CLI) <http://docs.platformio.org/en/latest/core.html?utm_source=github&utm_medium=core>`_
|
* `PlatformIO Core (CLI) <https://docs.platformio.org/en/latest/core.html?utm_source=github&utm_medium=core>`_
|
||||||
* `Library Management <http://docs.platformio.org/page/librarymanager/index.html?utm_source=github&utm_medium=core>`_
|
* `Library Management <https://docs.platformio.org/page/librarymanager/index.html?utm_source=github&utm_medium=core>`_
|
||||||
* `Project Examples <https://github.com/platformio/platformio-examples?utm_source=github&utm_medium=core>`_
|
* `Project Examples <https://github.com/platformio/platformio-examples?utm_source=github&utm_medium=core>`_
|
||||||
* `Desktop IDEs Integration <http://docs.platformio.org/page/ide.html?utm_source=github&utm_medium=core>`_
|
* `Desktop IDEs Integration <https://docs.platformio.org/page/ide.html?utm_source=github&utm_medium=core>`_
|
||||||
* `Continuous Integration <http://docs.platformio.org/page/ci/index.html?utm_source=github&utm_medium=core>`_
|
* `Continuous Integration <https://docs.platformio.org/page/ci/index.html?utm_source=github&utm_medium=core>`_
|
||||||
* `Advanced Scripting API <http://docs.platformio.org/page/projectconf/advanced_scripting.html?utm_source=github&utm_medium=core>`_
|
* `Advanced Scripting API <https://docs.platformio.org/page/projectconf/advanced_scripting.html?utm_source=github&utm_medium=core>`_
|
||||||
|
|
||||||
PIO Plus
|
PIO Plus
|
||||||
--------
|
--------
|
||||||
|
|
||||||
* `PIO Remote <http://docs.platformio.org/page/plus/pio-remote.html?utm_source=github&utm_medium=core>`_
|
* `PIO Remote <https://docs.platformio.org/page/plus/pio-remote.html?utm_source=github&utm_medium=core>`_
|
||||||
* `PIO Unified Debugger <http://docs.platformio.org/page/plus/debugging.html?utm_source=github&utm_medium=core>`_
|
* `PIO Unified Debugger <https://docs.platformio.org/page/plus/debugging.html?utm_source=github&utm_medium=core>`_
|
||||||
* `PIO Unit Testing <http://docs.platformio.org/en/latest/plus/unit-testing.html?utm_source=github&utm_medium=core>`_
|
* `PIO Unit Testing <https://docs.platformio.org/en/latest/plus/unit-testing.html?utm_source=github&utm_medium=core>`_
|
||||||
* `Cloud IDEs Integration <http://docs.platformio.org/en/latest/ide.html?utm_source=github&utm_medium=core#solution-pio-delivery>`_
|
* `Cloud IDEs Integration <https://docs.platformio.org/en/latest/ide.html?utm_source=github&utm_medium=core#solution-pio-delivery>`_
|
||||||
* `Integration Services <https://platformio.org/pricing?utm_source=github&utm_medium=core#enterprise-features>`_
|
* `Integration Services <https://platformio.org/pricing?utm_source=github&utm_medium=core#enterprise-features>`_
|
||||||
|
|
||||||
Registry
|
Registry
|
||||||
|
2
docs
2
docs
Submodule docs updated: 042e123ca1...cde097074f
2
examples
2
examples
Submodule examples updated: 40bdd9e1b4...caae30b64a
@ -135,7 +135,7 @@ An unexpected error occurred. Further steps:
|
|||||||
`pip install -U platformio` command
|
`pip install -U platformio` command
|
||||||
|
|
||||||
* Try to find answer in FAQ Troubleshooting section
|
* Try to find answer in FAQ Troubleshooting section
|
||||||
http://docs.platformio.org/page/faq.html
|
https://docs.platformio.org/page/faq.html
|
||||||
|
|
||||||
* Report this problem to the developers
|
* Report this problem to the developers
|
||||||
https://github.com/platformio/platformio-core/issues
|
https://github.com/platformio/platformio-core/issues
|
||||||
|
@ -63,7 +63,7 @@ DEFAULT_SETTINGS = {
|
|||||||
},
|
},
|
||||||
"enable_telemetry": {
|
"enable_telemetry": {
|
||||||
"description":
|
"description":
|
||||||
("Telemetry service <http://docs.platformio.org/page/"
|
("Telemetry service <https://docs.platformio.org/page/"
|
||||||
"userguide/cmd_settings.html?#enable-telemetry> (Yes/No)"),
|
"userguide/cmd_settings.html?#enable-telemetry> (Yes/No)"),
|
||||||
"value":
|
"value":
|
||||||
True
|
True
|
||||||
|
@ -210,5 +210,5 @@ if "idedata" in COMMAND_LINE_TARGETS:
|
|||||||
"\nUnicodeDecodeError: Non-ASCII characters found in build "
|
"\nUnicodeDecodeError: Non-ASCII characters found in build "
|
||||||
"environment\n"
|
"environment\n"
|
||||||
"See explanation in FAQ > Troubleshooting > Building\n"
|
"See explanation in FAQ > Troubleshooting > Building\n"
|
||||||
"http://docs.platformio.org/page/faq.html\n\n")
|
"https://docs.platformio.org/page/faq.html\n\n")
|
||||||
env.Exit(1)
|
env.Exit(1)
|
||||||
|
@ -808,7 +808,7 @@ def GetLibBuilders(env): # pylint: disable=too-many-branches
|
|||||||
if verbose and found_incompat:
|
if verbose and found_incompat:
|
||||||
sys.stderr.write(
|
sys.stderr.write(
|
||||||
"More details about \"Library Compatibility Mode\": "
|
"More details about \"Library Compatibility Mode\": "
|
||||||
"http://docs.platformio.org/page/librarymanager/ldf.html#"
|
"https://docs.platformio.org/page/librarymanager/ldf.html#"
|
||||||
"ldf-compat-mode\n")
|
"ldf-compat-mode\n")
|
||||||
|
|
||||||
DefaultEnvironment()['__PIO_LIB_BUILDERS'] = items
|
DefaultEnvironment()['__PIO_LIB_BUILDERS'] = items
|
||||||
|
@ -161,7 +161,7 @@ def AutodetectUploadPort(*args, **kwargs):
|
|||||||
sys.stderr.write(
|
sys.stderr.write(
|
||||||
"\nWarning! Please install `99-platformio-udev.rules` and "
|
"\nWarning! Please install `99-platformio-udev.rules` and "
|
||||||
"check that your board's PID and VID are listed in the rules."
|
"check that your board's PID and VID are listed in the rules."
|
||||||
"\n http://docs.platformio.org/en/latest/faq.html"
|
"\n https://docs.platformio.org/en/latest/faq.html"
|
||||||
"#platformio-udev-rules\n")
|
"#platformio-udev-rules\n")
|
||||||
env.Replace(UPLOAD_PORT=_look_for_serial_port())
|
env.Replace(UPLOAD_PORT=_look_for_serial_port())
|
||||||
|
|
||||||
|
@ -172,7 +172,7 @@ For example, see how can be organized `Foo` and `Bar` libraries:
|
|||||||
| | |--src
|
| | |--src
|
||||||
| | |- Bar.c
|
| | |- Bar.c
|
||||||
| | |- Bar.h
|
| | |- Bar.h
|
||||||
| | |- library.json (optional, custom build options, etc) http://docs.platformio.org/page/librarymanager/config.html
|
| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
|
||||||
| |
|
| |
|
||||||
| |--Foo
|
| |--Foo
|
||||||
| | |- Foo.c
|
| | |- Foo.c
|
||||||
@ -195,7 +195,7 @@ PlatformIO will find your libraries automatically, configure preprocessor's
|
|||||||
include paths and build them.
|
include paths and build them.
|
||||||
|
|
||||||
More information about PlatformIO Library Dependency Finder
|
More information about PlatformIO Library Dependency Finder
|
||||||
- http://docs.platformio.org/page/librarymanager/ldf.html
|
- https://docs.platformio.org/page/librarymanager/ldf.html
|
||||||
""")
|
""")
|
||||||
|
|
||||||
|
|
||||||
@ -205,7 +205,7 @@ def init_ci_conf(project_dir):
|
|||||||
with open(join(project_dir, ".travis.yml"), "w") as f:
|
with open(join(project_dir, ".travis.yml"), "w") as f:
|
||||||
f.write("""# Continuous Integration (CI) is the practice, in software
|
f.write("""# Continuous Integration (CI) is the practice, in software
|
||||||
# engineering, of merging all developer working copies with a shared mainline
|
# engineering, of merging all developer working copies with a shared mainline
|
||||||
# several times a day < http://docs.platformio.org/page/ci/index.html >
|
# several times a day < https://docs.platformio.org/page/ci/index.html >
|
||||||
#
|
#
|
||||||
# Documentation:
|
# Documentation:
|
||||||
#
|
#
|
||||||
@ -213,10 +213,10 @@ def init_ci_conf(project_dir):
|
|||||||
# < https://docs.travis-ci.com/user/integration/platformio/ >
|
# < https://docs.travis-ci.com/user/integration/platformio/ >
|
||||||
#
|
#
|
||||||
# * PlatformIO integration with Travis CI
|
# * PlatformIO integration with Travis CI
|
||||||
# < http://docs.platformio.org/page/ci/travis.html >
|
# < https://docs.platformio.org/page/ci/travis.html >
|
||||||
#
|
#
|
||||||
# * User Guide for `platformio ci` command
|
# * User Guide for `platformio ci` command
|
||||||
# < http://docs.platformio.org/page/userguide/cmd_ci.html >
|
# < https://docs.platformio.org/page/userguide/cmd_ci.html >
|
||||||
#
|
#
|
||||||
#
|
#
|
||||||
# Please choice one of the following templates (proposed below) and uncomment
|
# Please choice one of the following templates (proposed below) and uncomment
|
||||||
|
@ -228,7 +228,7 @@ def lib_search(query, json_output, page, noninteractive, **filters):
|
|||||||
click.echo("For more examples and advanced search syntax, "
|
click.echo("For more examples and advanced search syntax, "
|
||||||
"please use documentation:")
|
"please use documentation:")
|
||||||
click.secho(
|
click.secho(
|
||||||
"http://docs.platformio.org/page/userguide/lib/cmd_search.html\n",
|
"https://docs.platformio.org/page/userguide/lib/cmd_search.html\n",
|
||||||
fg="cyan")
|
fg="cyan")
|
||||||
return
|
return
|
||||||
|
|
||||||
|
@ -63,7 +63,7 @@ def cli(dev):
|
|||||||
fg="green")
|
fg="green")
|
||||||
click.echo("Release notes: ", nl=False)
|
click.echo("Release notes: ", nl=False)
|
||||||
click.secho(
|
click.secho(
|
||||||
"http://docs.platformio.org/en/latest/history.html", fg="cyan")
|
"https://docs.platformio.org/en/latest/history.html", fg="cyan")
|
||||||
except Exception as e: # pylint: disable=broad-except
|
except Exception as e: # pylint: disable=broad-except
|
||||||
if not r:
|
if not r:
|
||||||
raise exception.UpgradeError("\n".join([str(cmd), str(e)]))
|
raise exception.UpgradeError("\n".join([str(cmd), str(e)]))
|
||||||
|
@ -241,7 +241,7 @@ class UpgradeError(PlatformioException):
|
|||||||
|
|
||||||
* Upgrade using `pip install -U platformio`
|
* Upgrade using `pip install -U platformio`
|
||||||
* Try different installation/upgrading steps:
|
* Try different installation/upgrading steps:
|
||||||
http://docs.platformio.org/page/installation.html
|
https://docs.platformio.org/page/installation.html
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
@ -265,7 +265,7 @@ class DebugSupportError(PlatformioException):
|
|||||||
|
|
||||||
MESSAGE = ("Currently, PlatformIO does not support debugging for `{0}`.\n"
|
MESSAGE = ("Currently, PlatformIO does not support debugging for `{0}`.\n"
|
||||||
"Please contact support@pioplus.com or visit "
|
"Please contact support@pioplus.com or visit "
|
||||||
"< http://docs.platformio.org/page/plus/debugging.html >")
|
"< https://docs.platformio.org/page/plus/debugging.html >")
|
||||||
|
|
||||||
|
|
||||||
class DebugInvalidOptions(PlatformioException):
|
class DebugInvalidOptions(PlatformioException):
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"!!! WARNING !!!": "PLEASE DO NOT MODIFY THIS FILE! USE http://docs.platformio.org/page/projectconf/section_env_build.html#build-flags",
|
"!!! WARNING !!!": "PLEASE DO NOT MODIFY THIS FILE! USE https://docs.platformio.org/page/projectconf/section_env_build.html#build-flags",
|
||||||
"configurations": [
|
"configurations": [
|
||||||
{
|
{
|
||||||
% import platform
|
% import platform
|
||||||
|
@ -2,8 +2,8 @@
|
|||||||
|
|
||||||
// PIO Unified Debugger
|
// PIO Unified Debugger
|
||||||
//
|
//
|
||||||
// Documentation: http://docs.platformio.org/page/plus/debugging.html
|
// Documentation: https://docs.platformio.org/page/plus/debugging.html
|
||||||
// Configuration: http://docs.platformio.org/page/projectconf/section_env_debug.html
|
// Configuration: https://docs.platformio.org/page/projectconf/section_env_debug.html
|
||||||
|
|
||||||
% from os.path import dirname, join
|
% from os.path import dirname, join
|
||||||
%
|
%
|
||||||
|
@ -179,7 +179,7 @@ def after_upgrade(ctx):
|
|||||||
click.secho(
|
click.secho(
|
||||||
"Please remove multiple PIO Cores from a system:", fg="yellow")
|
"Please remove multiple PIO Cores from a system:", fg="yellow")
|
||||||
click.secho(
|
click.secho(
|
||||||
"http://docs.platformio.org/page/faq.html"
|
"https://docs.platformio.org/page/faq.html"
|
||||||
"#multiple-pio-cores-in-a-system",
|
"#multiple-pio-cores-in-a-system",
|
||||||
fg="cyan")
|
fg="cyan")
|
||||||
click.secho("*" * terminal_width, fg="yellow")
|
click.secho("*" * terminal_width, fg="yellow")
|
||||||
@ -274,7 +274,8 @@ def check_platformio_upgrade():
|
|||||||
click.secho("pip install -U platformio", fg="cyan", nl=False)
|
click.secho("pip install -U platformio", fg="cyan", nl=False)
|
||||||
click.secho("` command.", fg="yellow")
|
click.secho("` command.", fg="yellow")
|
||||||
click.secho("Changes: ", fg="yellow", nl=False)
|
click.secho("Changes: ", fg="yellow", nl=False)
|
||||||
click.secho("http://docs.platformio.org/en/latest/history.html", fg="cyan")
|
click.secho(
|
||||||
|
"https://docs.platformio.org/en/latest/history.html", fg="cyan")
|
||||||
click.echo("*" * terminal_width)
|
click.echo("*" * terminal_width)
|
||||||
click.echo("")
|
click.echo("")
|
||||||
|
|
||||||
|
@ -6,4 +6,4 @@
|
|||||||
; Advanced options: extra scripting
|
; Advanced options: extra scripting
|
||||||
;
|
;
|
||||||
; Please visit documentation for the other options and examples
|
; Please visit documentation for the other options and examples
|
||||||
; http://docs.platformio.org/page/projectconf.html
|
; https://docs.platformio.org/page/projectconf.html
|
||||||
|
@ -317,7 +317,7 @@ def get_projectbuild_dir(force=False):
|
|||||||
with open(dontmod_path, "w") as fp:
|
with open(dontmod_path, "w") as fp:
|
||||||
fp.write("""
|
fp.write("""
|
||||||
[InternetShortcut]
|
[InternetShortcut]
|
||||||
URL=http://docs.platformio.org/page/projectconf/section_platformio.html#build-dir
|
URL=https://docs.platformio.org/page/projectconf/section_platformio.html#build-dir
|
||||||
""")
|
""")
|
||||||
except Exception as e: # pylint: disable=broad-except
|
except Exception as e: # pylint: disable=broad-except
|
||||||
if not force:
|
if not force:
|
||||||
|
@ -16,7 +16,7 @@
|
|||||||
#
|
#
|
||||||
# INSTALLATION
|
# INSTALLATION
|
||||||
#
|
#
|
||||||
# Please visit > http://docs.platformio.org/en/latest/faq.html#platformio-udev-rules
|
# Please visit > https://docs.platformio.org/en/latest/faq.html#platformio-udev-rules
|
||||||
#
|
#
|
||||||
#####################################################################################
|
#####################################################################################
|
||||||
|
|
||||||
|
@ -719,7 +719,7 @@ def update_project_examples():
|
|||||||
{description}
|
{description}
|
||||||
|
|
||||||
* [Home](https://platformio.org/platforms/{name}) (home page in PlatformIO Registry)
|
* [Home](https://platformio.org/platforms/{name}) (home page in PlatformIO Registry)
|
||||||
* [Documentation](http://docs.platformio.org/page/platforms/{name}.html) (advanced usage, packages, boards, frameworks, etc.)
|
* [Documentation](https://docs.platformio.org/page/platforms/{name}.html) (advanced usage, packages, boards, frameworks, etc.)
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
@ -731,7 +731,7 @@ def update_project_examples():
|
|||||||
{description}
|
{description}
|
||||||
|
|
||||||
* [Home](https://platformio.org/frameworks/{name}) (home page in PlatformIO Registry)
|
* [Home](https://platformio.org/frameworks/{name}) (home page in PlatformIO Registry)
|
||||||
* [Documentation](http://docs.platformio.org/page/frameworks/{name}.html)
|
* [Documentation](https://docs.platformio.org/page/frameworks/{name}.html)
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
@ -803,7 +803,7 @@ def update_project_examples():
|
|||||||
examples="\n".join(
|
examples="\n".join(
|
||||||
framework_examples_md_lines[framework['name']])))
|
framework_examples_md_lines[framework['name']])))
|
||||||
url = campaign_url(
|
url = campaign_url(
|
||||||
"http://docs.platformio.org/en/latest/frameworks/%s.html#examples"
|
"https://docs.platformio.org/en/latest/frameworks/%s.html#examples"
|
||||||
% framework['name'],
|
% framework['name'],
|
||||||
source="github",
|
source="github",
|
||||||
medium="examples")
|
medium="examples")
|
||||||
|
Reference in New Issue
Block a user