Skip to content

Commit

Permalink
Mass replacement of http with https urls, fixed broken urls
Browse files Browse the repository at this point in the history
  • Loading branch information
krzychb committed Sep 6, 2017
1 parent 604308f commit 672390c
Show file tree
Hide file tree
Showing 24 changed files with 69 additions and 69 deletions.
8 changes: 4 additions & 4 deletions components/bootloader/Kconfig.projbuild
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ config SECURE_BOOT_ENABLED

When enabling secure boot, JTAG and ROM BASIC Interpreter are permanently disabled by default.

Refer to http://esp-idf.readthedocs.io/en/latest/security/secure-boot.html before enabling.
Refer to https://esp-idf.readthedocs.io/en/latest/security/secure-boot.html before enabling.

choice SECURE_BOOTLOADER_MODE
bool "Secure bootloader mode"
Expand Down Expand Up @@ -122,7 +122,7 @@ config SECURE_BOOT_VERIFICATION_KEY
PEM formatted private key using the espsecure.py
extract_public_key command.

Refer to http://esp-idf.readthedocs.io/en/latest/security/secure-boot.html before enabling.
Refer to https://esp-idf.readthedocs.io/en/latest/security/secure-boot.html before enabling.

config SECURE_BOOT_INSECURE
bool "Allow potentially insecure options"
Expand All @@ -133,7 +133,7 @@ config SECURE_BOOT_INSECURE

Only enable these options if you are very sure.

Refer to http://esp-idf.readthedocs.io/en/latest/security/secure-boot.html before enabling.
Refer to https://esp-idf.readthedocs.io/en/latest/security/secure-boot.html before enabling.

config FLASH_ENCRYPTION_ENABLED
bool "Enable flash encryption on boot (READ DOCS FIRST)"
Expand All @@ -144,7 +144,7 @@ config FLASH_ENCRYPTION_ENABLED
Note: After first boot, the system will be permanently encrypted. Re-flashing an encrypted
system is complicated and not always possible.

Read http://esp-idf.readthedocs.io/en/latest/security/flash-encryption.html before enabling.
Read https://esp-idf.readthedocs.io/en/latest/security/flash-encryption.html before enabling.

config FLASH_ENCRYPTION_INSECURE
bool "Allow potentially insecure options"
Expand Down
4 changes: 2 additions & 2 deletions docs/COPYRIGHT.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,10 @@ Copyright (C) 2011, ChaN, all right reserved.
.. _Newlib: https://sourceware.org/newlib/
.. _FreeRTOS: http://freertos.org/
.. _esptool.py: https://github.com/espressif/esptool
.. _LWIP: http://savannah.nongnu.org/projects/lwip/
.. _LWIP: https://savannah.nongnu.org/projects/lwip/
.. _TinyBasic: https://github.com/BleuLlama/TinyBasicPlus
.. _miniz: https://code.google.com/archive/p/miniz/
.. _wpa_supplicant: http://w1.fi/wpa_supplicant/
.. _wpa_supplicant: https://w1.fi/wpa_supplicant/
.. _FreeBSD net80211: https://github.com/freebsd/freebsd/tree/master/sys/net80211
.. _TJpgDec: http://elm-chan.org/fsw/tjpgd/00index.html
.. _JSMN: http://zserge.com/jsmn.html
Expand Down
2 changes: 1 addition & 1 deletion docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
# Make sure that correct warnings are generated to flag issues with documented code
#
# For the complete list of configuration statements see:
# http://www.stack.nl/~dimitri/doxygen/manual/config.html
# https://www.stack.nl/~dimitri/doxygen/manual/config.html


PROJECT_NAME = "ESP32 Programming Guide"
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Documentation Source Folder

This folder contains source files of [ESP-IDF documentation](http://esp-idf.readthedocs.io/).
This folder contains source files of [ESP-IDF documentation](https://esp-idf.readthedocs.io/).

The sources do not render well in GitHub and some information is not visible at all.

Use actual documentation generated instantly on each commit:

* Main server: http://esp-idf.readthedocs.io/ or http://esp-idf.rtfd.io/
* Main server: https://esp-idf.readthedocs.io/ or http://esp-idf.rtfd.io/
* Mirror: https://dl.espressif.com/doc/esp-idf/latest/

4 changes: 2 additions & 2 deletions docs/api-guides/jtag-debugging/debugging-examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ Checking and setting memory

To display or set contents of memory use "Memory" tab at the bottom of "Debug" perspective.

With the "Memory" tab, we will read from and write to the memory location ``0x3FF44004`` labeled as ``GPIO_OUT_REG`` used to set and clear individual GPIO's. For more information please refer to `ESP32 Technical Reference Manual <http://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf>`__, chapter IO_MUX and GPIO Matrix.
With the "Memory" tab, we will read from and write to the memory location ``0x3FF44004`` labeled as ``GPIO_OUT_REG`` used to set and clear individual GPIO's. For more information please refer to `ESP32 Technical Reference Manual <https://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf>`__, chapter IO_MUX and GPIO Matrix.

Being in the same ``blink.c`` project as before, set two breakpoints right after ``gpio_set_level`` instruction. Click "Memory" tab and then "Add Memory Monitor" button. Enter ``0x3FF44004`` in provided dialog.

Expand Down Expand Up @@ -512,7 +512,7 @@ Checking and setting memory

Displaying the contents of memory is done with command ``x``. With additional parameters you may vary the format and count of memory locations displayed. Run ``help x`` to see more details. Companion command to ``x`` is ``set`` that let you write values to the memory.

We will demonstrate how ``x`` and ``set`` work by reading from and writing to the memory location ``0x3FF44004`` labeled as ``GPIO_OUT_REG`` used to set and clear individual GPIO's. For more information please refer to `ESP32 Technical Reference Manual <http://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf>`__, chapter IO_MUX and GPIO Matrix.
We will demonstrate how ``x`` and ``set`` work by reading from and writing to the memory location ``0x3FF44004`` labeled as ``GPIO_OUT_REG`` used to set and clear individual GPIO's. For more information please refer to `ESP32 Technical Reference Manual <https://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf>`__, chapter IO_MUX and GPIO Matrix.

Being in the same ``blink.c`` project as before, set two breakpoints right after ``gpio_set_level`` instruction. Enter two times ``c`` to get to the break point followed by ``x /1wx 0x3FF44004`` to display contents of ``GPIO_OUT_REG`` memory location::

Expand Down
2 changes: 1 addition & 1 deletion docs/api-guides/jtag-debugging/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The key software and hardware to perform debugging of ESP32 with OpenOCD over JT

Under "Application Loading and Monitoring" there is another software and hardware to compile, build and flash application to ESP32, as well as to provide means to monitor diagnostic messages from ESP32.

Debugging using JTAG and application loading / monitoring is integrated under the `Eclipse <http://www.eclipse.org/>`_ environment, to provide quick and easy transition from writing, compiling and loading the code to debugging, back to writing the code, and so on. All the software is available for Windows, Linux and MacOS platforms.
Debugging using JTAG and application loading / monitoring is integrated under the `Eclipse <https://www.eclipse.org/>`_ environment, to provide quick and easy transition from writing, compiling and loading the code to debugging, back to writing the code, and so on. All the software is available for Windows, Linux and MacOS platforms.

If the :doc:`ESP32 WROVER KIT <../../hw-reference/modules-and-boards>` is used, then connection from PC to ESP32 is done effectively with a single USB cable thanks to FT2232H chip installed on WROVER, which provides two USB channels, one for JTAG and the second for UART connection.

Expand Down
12 changes: 6 additions & 6 deletions docs/contribute/documenting-code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The purpose of this description is to provide quick summary on documentation sty
Introduction
------------

When documenting code for this repository, please follow `Doxygen style <http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#specialblock>`_. You are doing it by inserting special commands, for instance ``@param``, into standard comments blocks, for example: ::
When documenting code for this repository, please follow `Doxygen style <https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#specialblock>`_. You are doing it by inserting special commands, for instance ``@param``, into standard comments blocks, for example: ::

/**
* @param ratio this is oxygen to air ratio
Expand All @@ -21,7 +21,7 @@ Typical comment block, that contains documentation of a function, looks like bel
:align: center
:alt: Sample inline code documentation

Doxygen supports couple of formatting styles. It also gives you great flexibility on level of details to include in documentation. To get familiar with available features, please check data reach and very well organized `Doxygen Manual <http://www.stack.nl/~dimitri/doxygen/manual/index.html>`_.
Doxygen supports couple of formatting styles. It also gives you great flexibility on level of details to include in documentation. To get familiar with available features, please check data reach and very well organized `Doxygen Manual <https://www.stack.nl/~dimitri/doxygen/manual/index.html>`_.


Why we need it?
Expand Down Expand Up @@ -125,7 +125,7 @@ There is couple of tips, how you can make your documentation even better and mor
5. Use markdown to make your documentation even more readable. You will add headers, links, tables and more. ::

*
* [ESP32 Technical Reference](http://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf)
* [ESP32 Technical Reference](https://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf)
*

.. note::
Expand Down Expand Up @@ -171,7 +171,7 @@ OK, but I am new to Sphinx!

3. You will likely want to see how documentation builds and looks like before posting it on the GitHub. There are two options to do so:

* Install `Sphinx <http://www.sphinx-doc.org/>`_, `Breathe <https://breathe.readthedocs.io/>`_ and `Doxygen <http://www.stack.nl/~dimitri/doxygen/>`_ to build it locally, see chapter below.
* Install `Sphinx <http://www.sphinx-doc.org/>`_, `Breathe <https://breathe.readthedocs.io/>`_ and `Doxygen <https://www.stack.nl/~dimitri/doxygen/>`_ to build it locally, see chapter below.

* Set up an account on `Read the Docs <https://readthedocs.org/>`_ and build documentation in the cloud. Read the Docs provides document building and hosting for free and their service works really quick and great.

Expand All @@ -183,12 +183,12 @@ Setup for building documentation locally

You can setup environment to build documentation locally on your PC by installing:

1. Doxygen - http://www.stack.nl/~dimitri/doxygen/
1. Doxygen - https://www.stack.nl/~dimitri/doxygen/
2. Sphinx - https://github.com/sphinx-doc/sphinx/#readme-for-sphinx
3. Docment theme "sphinx_rtd_theme" - https://github.com/rtfd/sphinx_rtd_theme
4. Breathe - https://github.com/michaeljones/breathe#breathe

The package "sphinx_rtd_theme" is added to have the same "look and feel" of `ESP32 Programming Guide <http://esp-idf.readthedocs.io/en/latest/index.html>`_ documentation like on the "Read the Docs" hosting site.
The package "sphinx_rtd_theme" is added to have the same "look and feel" of `ESP32 Programming Guide <https://esp-idf.readthedocs.io/en/latest/index.html>`_ documentation like on the "Read the Docs" hosting site.

Installation of Doxygen is OS dependent:

Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/eclipse-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,5 +105,5 @@ Related Documents
eclipse-setup-windows


.. _eclipse.org: http://www.eclipse.org/
.. _eclipse.org: https://www.eclipse.org/

2 changes: 1 addition & 1 deletion docs/get-started/establish-serial-connection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Connect the ESP32 board to the PC using the USB cable. If device driver does not

Below are the links to Windows and MacOS drivers for ESP32 boards produced by Espressif:

* ESP32 Core Board - `CP210x USB to UART Bridge VCP Drivers <http://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`_
* ESP32 Core Board - `CP210x USB to UART Bridge VCP Drivers <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`_

* ESP32 WROVER KIT and ESP32 Demo Board - `FTDI Virtual COM Port Drivers <http://www.ftdichip.com/Drivers/D2XX.htm>`_

Expand Down
10 changes: 5 additions & 5 deletions docs/get-started/get-started-devkitc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ What You Need
Overview
--------

ESP32-DevKitC is a small-sized ESP32-based development board produced by `Espressif <http://espressif.com>`_. Most of the I/O pins are broken out to the pin headers on both sides for easy interfacing. Developers can connect these pins to peripherals as needed. Standard headers also make development easy and convenient when using a breadboard.
ESP32-DevKitC is a small-sized ESP32-based development board produced by `Espressif <https://espressif.com>`_. Most of the I/O pins are broken out to the pin headers on both sides for easy interfacing. Developers can connect these pins to peripherals as needed. Standard headers also make development easy and convenient when using a breadboard.


Functional Description
Expand All @@ -24,7 +24,7 @@ Functional Description
The following list and figure below describe key components, interfaces and controls of ESP32-DevKitC board.

ESP-WROOM-32
Standard `ESP-WROOM-32 <http://www.espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ module soldered to the ESP32-DevKitC board.
Standard `ESP-WROOM-32 <https://www.espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ module soldered to the ESP32-DevKitC board.
EN
Reset button: pressing this button resets the system.
Boot
Expand Down Expand Up @@ -58,6 +58,6 @@ To start development of applications, proceed to section :doc:`index`, that will
Related Documents
-----------------

* `ESP32-DevKitC schematic <http://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`_ (PDF)
* `ESP32 Datasheet <http://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
* `ESP-WROOM-32 Datasheet <http://espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ (PDF)
* `ESP32-DevKitC schematic <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`_ (PDF)
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
* `ESP-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ (PDF)
8 changes: 4 additions & 4 deletions docs/get-started/get-started-wrover-kit-v2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ What You Need
Overview
^^^^^^^^

The ESP-WROVER-KIT is a development board produced by `Espressif <http://espressif.com>`_ built around ESP32. This board is compatible with ESP32 modules, including the ESP-WROOM-32 and ESP32-WROVER. The ESP-WROVER-KIT features support for an LCD and MicroSD card. The I/O pins have been broken out from the ESP32 module for easy extension. The board carries an advanced multi-protocol USB bridge (the FTDI FT2232HL), enabling developers to use JTAG directly to debug the ESP32 through the USB interface. The development board makes secondary development easy and cost-effective.
The ESP-WROVER-KIT is a development board produced by `Espressif <https://espressif.com>`_ built around ESP32. This board is compatible with ESP32 modules, including the ESP-WROOM-32 and ESP32-WROVER. The ESP-WROVER-KIT features support for an LCD and MicroSD card. The I/O pins have been broken out from the ESP32 module for easy extension. The board carries an advanced multi-protocol USB bridge (the FTDI FT2232HL), enabling developers to use JTAG directly to debug the ESP32 through the USB interface. The development board makes secondary development easy and cost-effective.

.. note::

Expand Down Expand Up @@ -173,9 +173,9 @@ Related Documents
-----------------

* `ESP-WROVER-KIT V2 schematic`_ (PDF)
* `ESP32 Datasheet <http://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
* `ESP-WROOM-32 Datasheet <http://www.espressif.com/sites/default/files/documentation/esp_wroom_32_datasheet_en.pdf>`_ (PDF)
* `ESP32-WROVER Datasheet <http://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
* `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
* :doc:`../api-guides/jtag-debugging/index`
* :doc:`../hw-reference/modules-and-boards`

Expand All @@ -189,4 +189,4 @@ Related Documents
.. |jp11-rx-tx| image:: ../_static/wrover-jp11-tx-rx.png
.. |jp14| image:: ../_static/wrover-jp14.png

.. _ESP-WROVER-KIT V2 schematic: http://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-2.pdf
.. _ESP-WROVER-KIT V2 schematic: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-2.pdf
10 changes: 5 additions & 5 deletions docs/get-started/get-started-wrover-kit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ What You Need
Overview
^^^^^^^^

The ESP-WROVER-KIT is a development board produced by `Espressif <http://espressif.com>`_ built around ESP32. This board is compatible with ESP32 modules, including the ESP-WROOM-32 and ESP32-WROVER. The ESP-WROVER-KIT features support for an LCD and MicroSD card. The I/O pins have been broken out from the ESP32 module for easy extension. The board carries an advanced multi-protocol USB bridge (the FTDI FT2232HL), enabling developers to use JTAG directly to debug the ESP32 through the USB interface. The development board makes secondary development easy and cost-effective.
The ESP-WROVER-KIT is a development board produced by `Espressif <https://espressif.com>`_ built around ESP32. This board is compatible with ESP32 modules, including the ESP-WROOM-32 and ESP32-WROVER. The ESP-WROVER-KIT features support for an LCD and MicroSD card. The I/O pins have been broken out from the ESP32 module for easy extension. The board carries an advanced multi-protocol USB bridge (the FTDI FT2232HL), enabling developers to use JTAG directly to debug the ESP32 through the USB interface. The development board makes secondary development easy and cost-effective.

.. note::

Expand Down Expand Up @@ -324,9 +324,9 @@ Related Documents
-----------------

* `ESP-WROVER-KIT V3 schematic`_ (PDF)
* `ESP32 Datasheet <http://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
* `ESP32-WROVER Datasheet <http://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
* `ESP-WROOM-32 Datasheet <http://espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ (PDF)
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
* `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
* `ESP-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ (PDF)
* :doc:`../api-guides/jtag-debugging/index`
* :doc:`../hw-reference/modules-and-boards`

Expand All @@ -339,7 +339,7 @@ Related Documents
.. |jp11-rx-tx| image:: ../_static/wrover-jp11-tx-rx.png
.. |jp14| image:: ../_static/wrover-jp14.png

.. _ESP-WROVER-KIT V3 schematic: http://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf
.. _ESP-WROVER-KIT V3 schematic: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf

.. toctree::
:hidden:
Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/idf-monitor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,4 @@ Issues Observed on Windows
.. _addr2line: https://sourceware.org/binutils/docs/binutils/addr2line.html
.. _gdb: https://sourceware.org/gdb/download/onlinedocs/
.. _pySerial: https://github.com/pyserial/pyserial
.. _miniterm: http://pyserial.readthedocs.org/en/latest/tools.html#module-serial.tools.miniterm
.. _miniterm: https://pyserial.readthedocs.org/en/latest/tools.html#module-serial.tools.miniterm
2 changes: 1 addition & 1 deletion docs/get-started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To develop applications for ESP32 you need:
* **PC** loaded with either Windows, Linux or Mac operating system
* **Toolchain** to build the **Application** for ESP32
* **ESP-IDF** that essentially contains API for ESP32 and scripts to operate the **Toolchain**
* A text editor to write programs (**Projects**) in C, e.g. `Eclipse <http://www.eclipse.org/>`_
* A text editor to write programs (**Projects**) in C, e.g. `Eclipse <https://www.eclipse.org/>`_
* The **ESP32** board itself and a **USB cable** to connect it to the **PC**

.. figure:: ../_static/what-you-need.png
Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/macos-setup-scratch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Compile the Toolchain from Source

- Install either MacPorts_ or homebrew_ package manager. MacPorts needs a full XCode installation, while homebrew only needs XCode command line tools.

.. _homebrew: http://brew.sh/
.. _homebrew: https://brew.sh/
.. _MacPorts: https://www.macports.org/install.php

- with MacPorts::
Expand Down
Loading

0 comments on commit 672390c

Please sign in to comment.