aditihilbert closed pull request #393: automated asf-site build
URL: https://github.com/apache/mynewt-site/pull/393
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/master/mkdocs/search_index.json b/master/mkdocs/search_index.json
index ae688f2bc..bfdd02138 100644
--- a/master/mkdocs/search_index.json
+++ b/master/mkdocs/search_index.json
@@ -332,7 +332,7 @@
},
{
"location": "/os/get_started/cross_tools/",
- "text": "Installing the Cross Tools for ARM\n\n\nThis page shows
you how to install the tools to build, run, and debug Mynewt OS applications
that run on supported ARM target boards. It shows you how to install the
following tools on Mac OS, Linux and Windows:\n\n\n\n\nARM cross toolchain to
compile and build Mynewt applications for the target boards.\n\n\nDebuggers to
load and debug applications on the target boards.\n\n\n\n\n\n\nInstalling the
ARM Cross Toolchain\n\n\nARM maintains a pre-built GNU toolchain with gcc and
gdb targeted at Embedded ARM Processors, namely Cortex-R/Cortex-M processor
families. Mynewt OS has been tested with version 4.9 of the toolchain and we
recommend you install this version to get started. Mynewt OS will eventually
work with multiple versions available, including the latest releases.
\n\n\nInstalling the ARM Toolchain For Mac OS X\n\n\nAdd the
\nPX4/homebrew-px4\n homebrew tap and install version 4.9 of the toolchain.
After installing, check that the symbolic link that homebrew created points to
the correct version of the debugger.\n\n\n$ brew tap PX4/homebrew-px4\n$ brew
update\n$ brew install gcc-arm-none-eabi-49\n$ arm-none-eabi-gcc --version
\narm-none-eabi-gcc (GNU Tools for ARM Embedded Processors) 4.9.3 20150529
(release) [ARM/embedded-4_9-branch revision 224288]\nCopyright (C) 2014 Free
Software Foundation, Inc.\nThis is free software; see the source for copying
conditions. There is NO\nwarranty; not even for MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.\n$ ls -al /usr/local/bin/arm-none-eabi-gdb\nlrwxr-xr-x 1
aditihilbert admin 69 Sep 22 17:16 /usr/local/bin/arm-none-eabi-gdb -\n
/usr/local/Cellar/gcc-arm-none-eabi-49/20150609/bin/arm-none-eabi-gdb\n\n\n\n\n\nNote:\n
If no version is specified, brew will install the latest version available.
\n\n\n\n\nInstalling the ARM Toolchain For Linux\n\n\nOn a Debian-based Linux
distribution, gcc 4.9.3 for ARM can be installed with\napt-get as documented
below. The steps are explained in depth
at\n\nhttps://launchpad.net/~team-gcc-arm-embedded/+archive/ubuntu/ppa\n.\n\n\n$
sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi \n$ sudo
add-apt-repository ppa:team-gcc-arm-embedded/ppa\n$ sudo apt-get update \n$
sudo apt-get install gcc-arm-none-eabi\n$ sudo apt-get install
gdb-arm-none-eabi\n\n\n\n\n\n\n\nInstalling the ARM Toolchain for
Windows\n\n\nStep 1: Download and run the \ninstaller\n to install
arm-none-eabi-gcc and arm-none-eabi-gdb. Select the default destination folder:
\nC:\\Program Files (x86)\\GNU Tools ARM Embedded\\4.9 2015q2\n. \n\n\nNotes:\n
\n\n\n\n\nCheck the \nAdd path to environment variable\n option before you
click the \nFinish\n button for the installation. \n\n\nYou may select a
different folder but the installation instructions use the default
values.\n\n\n\n\nStep 2: Check that you are using the installed versions
arm-none-eabi-gcc and arm-none-eabi-gdb. Open a MinGW terminal and run the
\nwhich\n commands. \n\n\nNote:\n You must start a new MinGW terminal to
inherit the new \nPath\n values.\n\n\n$ which arm-none-eabi-gcc\n/c/Program
Files (x86)/GNU Tools ARM Embedded/4.9 2015q2/bin/arm-none-eabi-gcc\n$which
arm-none-eabi-gdb\n/c/Program Files (x86)/GNU Tools ARM Embedded/4.9
2015q2/bin/arm-none-eabi-gdb\n\n\n\n\n\nInstalling the Debuggers\n\n\nMynewt
uses, depending on the board, either the OpenOCD or SEGGER J-Link debuggers.
\n\n\n\nInstalling the OpenOCD Debugger\n\n\nOpenOCD (Open On-Chip Debugger) is
open-source software that allows your\ncomputer to interface with the JTAG
debug connector on a variety of boards. A\nJTAG connection lets you debug and
test embedded target devices. For more on\nOpenOCD go to
\nhttp://openocd.org\n.\n\n\nOpenOCD version 0.10.0 with nrf52 support is
required. A binary for this version is available to download for Mac OS,
Linux, and Windows.\n\n\n\n\nInstalling OpenOCD on Mac OS\n\n\nStep 1: Download
the \nbinary tarball for Mac OS\n.\n\n\nStep 2: Change to the root directory:
\n\n\n$cd / \n\n\n\n\n\n\nStep 3: Untar the tarball and install into \n
/usr/local/bin\n. You will need to replace \n ~/Downloads \n with the
directory that the tarball is downloaded to. \n\n\nsudo tar -xf
~/Downloads/openocd-bin-0.10.0-MacOS.tgz\n\n\n\n\n\n\nStep 4: Check the OpenOCD
version you are using. \n\n\n$which openocd\n/usr/local/bin/openocd\n$openocd
-v\nOpen On-Chip Debugger 0.10.0\nLicensed under GNU GPL v2\nFor bug reports,
read\nhttp://openocd.org/doc/doxygen/bugs.html\n\n\n\n\n\nYou should see
version: \n0.10.0\n. \n\n\nIf you see one of these errors:\n\n\n\n\nLibrary not
loaded: /usr/local/lib/libusb-0.1.4.dylib - Run \nbrew install
libusb-compat\n.\n\n\nLibrary not loaded:
/usr/local/opt/libftdi/lib/libftdi1.2.dylib - Run \nbrew install
libftdi\n.\n\n\nLibrary not loaded: /usr/local/lib/libhidapi.0.dylib - Run
\nbrew install hidapi\n.\n\n\n\n\n\n\nInstalling OpenOCD on Linux\n\n\nStep 1:
Download the \nbinary tarball for Linux\n\n\nStep 2: Change to the root
directory: \n\n\n$cd / \n\n\n\n\n\n\nStep 3: Untar the tarball and install into
\n /usr/local/bin\n. You will need to replace \n ~/Downloads \n with the
directory that the tarball is downloaded to. \n\n\n Note:\n You must specify
the -p option for the tar command.\n\n\n$sudo tar -xpf
~/Downloads/openocd-bin-0.10.0-Linux.tgz\n\n\n\n\n\n\nStep 4: Check the OpenOCD
version you are using: \n\n\n$which openocd\n/usr/local/bin/openocd\n$openocd
-v\nOpen On-Chip Debugger 0.10.0\nLicensed under GNU GPL v2\nFor bug reports,
read\nhttp://openocd.org/doc/doxygen/bugs.html\n\n\n\n\n\nYou should see
version: \n0.10.0\n. \n\n\nIf you see any of these error
messages:\n\n\n\n\n\n\nopenocd: error while loading shared libraries:
libhidapi-hidraw.so.0: cannot open shared object file: No such file or
directory\n\n\n\n\n\n\nopenocd: error while loading shared libraries:
libusb-1.0.so.0: cannot open shared object file: No such file or directory
\n\n\n\n\n\n\nrun the following command to install the libraries: \n\n\n$sudo
apt-get install libhidapi-dev:i386\n\n\n\n\n\n\n\nInstalling OpenOCD on
Windows\n\n\nStep 1: Download the \nbinary zip file for Windows\n.\n\n\nStep 2:
Extract into the \nC:\\openocd-0.10.0\n folder. \n\n\nStep 3: Add the path: \n
C:\\openocd-0.10.0\\bin\n to your Windows User \nPath\n environment variable.
Note: You must add \nbin\n to the path.\n\n\nStep 4: Check the OpenOCD version
you are using. Open a new MinGW terminal and run the following commands:
\n\n\nNote:\n You must start a new MinGW terminal to inherit the new \nPath\n
values.\n\n\n$which openocd\n/c/openocd-0.10.0/bin/openocd\n$openocd -v\nOpen
On-Chip Debugger 0.10.0\nLicensed under GNU GPL v2\nFor bug reports, read\n
http://openocd.org/doc/doxygen/bugs.html\n\n\n\n\n\nYou should see version:
\n0.10.0\n. \n\n\n\n\nInstalling SEGGER J-Link\n\n\nYou can download and
install Segger J-LINK Software and documentation pack from \nSEGGER\n.
\n\n\nNote:\n On Windows, perform the following additonal steps:\n\n\n\n\nMake
note of the destination folder of your installation.\n\n\nAdd the installation
destination folder path to your Windows user \nPath\n environment variable.
You do not need to add \nbin\n to the path.\n\n\nOpen a new MinGW terminal to
inherit the new \nPath\n values.",
+ "text": "Installing the Cross Tools for ARM\n\n\nThis page shows
you how to install the tools to build, run, and debug Mynewt OS applications
that run on supported ARM target boards. It shows you how to install the
following tools on Mac OS, Linux and Windows:\n\n\n\n\nARM cross toolchain to
compile and build Mynewt applications for the target boards.\n\n\nDebuggers to
load and debug applications on the target boards.\n\n\n\n\n\n\nInstalling the
ARM Cross Toolchain\n\n\nARM maintains a pre-built GNU toolchain with gcc and
gdb targeted at Embedded ARM Processors, namely Cortex-R/Cortex-M processor
families. Mynewt OS has been tested with version 4.9 of the toolchain and we
recommend you install this version to get started. Mynewt OS will eventually
work with multiple versions available, including the latest releases.
\n\n\nInstalling the ARM Toolchain For Mac OS X\n\n\nAdd the
\nPX4/homebrew-px4\n homebrew tap and install version 4.9 of the toolchain.
After installing, check that the symbolic link that homebrew created points to
the correct version of the debugger.\n\n\n$ brew tap PX4/homebrew-px4\n$ brew
update\n$ brew install gcc-arm-none-eabi-49\n$ arm-none-eabi-gcc --version
\narm-none-eabi-gcc (GNU Tools for ARM Embedded Processors) 4.9.3 20150529
(release) [ARM/embedded-4_9-branch revision 224288]\nCopyright (C) 2014 Free
Software Foundation, Inc.\nThis is free software; see the source for copying
conditions. There is NO\nwarranty; not even for MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.\n$ ls -al /usr/local/bin/arm-none-eabi-gdb\nlrwxr-xr-x 1
aditihilbert admin 69 Sep 22 17:16 /usr/local/bin/arm-none-eabi-gdb -\n
/usr/local/Cellar/gcc-arm-none-eabi-49/20150609/bin/arm-none-eabi-gdb\n\n\n\n\n\nNote:\n
If no version is specified, brew will install the latest version available.
\n\n\n\n\nInstalling the ARM Toolchain For Linux\n\n\nOn a Debian-based Linux
distribution, gcc 4.9.3 for ARM can be installed with\napt-get as documented
below. The steps are explained in depth
at\n\nhttps://launchpad.net/~team-gcc-arm-embedded/+archive/ubuntu/ppa\n.\n\n\n$
sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi \n$ sudo
add-apt-repository ppa:team-gcc-arm-embedded/ppa\n$ sudo apt-get update \n$
sudo apt-get install gcc-arm-embedded\n\n\n\n\n\n\n\nInstalling the ARM
Toolchain for Windows\n\n\nStep 1: Download and run the \ninstaller\n to
install arm-none-eabi-gcc and arm-none-eabi-gdb. Select the default destination
folder: \nC:\\Program Files (x86)\\GNU Tools ARM Embedded\\4.9 2015q2\n.
\n\n\nNotes:\n \n\n\n\n\nCheck the \nAdd path to environment variable\n option
before you click the \nFinish\n button for the installation. \n\n\nYou may
select a different folder but the installation instructions use the default
values.\n\n\n\n\nStep 2: Check that you are using the installed versions
arm-none-eabi-gcc and arm-none-eabi-gdb. Open a MinGW terminal and run the
\nwhich\n commands. \n\n\nNote:\n You must start a new MinGW terminal to
inherit the new \nPath\n values.\n\n\n$ which arm-none-eabi-gcc\n/c/Program
Files (x86)/GNU Tools ARM Embedded/4.9 2015q2/bin/arm-none-eabi-gcc\n$which
arm-none-eabi-gdb\n/c/Program Files (x86)/GNU Tools ARM Embedded/4.9
2015q2/bin/arm-none-eabi-gdb\n\n\n\n\n\nInstalling the Debuggers\n\n\nMynewt
uses, depending on the board, either the OpenOCD or SEGGER J-Link debuggers.
\n\n\n\nInstalling the OpenOCD Debugger\n\n\nOpenOCD (Open On-Chip Debugger) is
open-source software that allows your\ncomputer to interface with the JTAG
debug connector on a variety of boards. A\nJTAG connection lets you debug and
test embedded target devices. For more on\nOpenOCD go to
\nhttp://openocd.org\n.\n\n\nOpenOCD version 0.10.0 with nrf52 support is
required. A binary for this version is available to download for Mac OS,
Linux, and Windows.\n\n\n\n\nInstalling OpenOCD on Mac OS\n\n\nStep 1: Download
the \nbinary tarball for Mac OS\n.\n\n\nStep 2: Change to the root directory:
\n\n\n$cd / \n\n\n\n\n\n\nStep 3: Untar the tarball and install into \n
/usr/local/bin\n. You will need to replace \n ~/Downloads \n with the
directory that the tarball is downloaded to. \n\n\nsudo tar -xf
~/Downloads/openocd-bin-0.10.0-MacOS.tgz\n\n\n\n\n\n\nStep 4: Check the OpenOCD
version you are using. \n\n\n$which openocd\n/usr/local/bin/openocd\n$openocd
-v\nOpen On-Chip Debugger 0.10.0\nLicensed under GNU GPL v2\nFor bug reports,
read\nhttp://openocd.org/doc/doxygen/bugs.html\n\n\n\n\n\nYou should see
version: \n0.10.0\n. \n\n\nIf you see one of these errors:\n\n\n\n\nLibrary not
loaded: /usr/local/lib/libusb-0.1.4.dylib - Run \nbrew install
libusb-compat\n.\n\n\nLibrary not loaded:
/usr/local/opt/libftdi/lib/libftdi1.2.dylib - Run \nbrew install
libftdi\n.\n\n\nLibrary not loaded: /usr/local/lib/libhidapi.0.dylib - Run
\nbrew install hidapi\n.\n\n\n\n\n\n\nInstalling OpenOCD on Linux\n\n\nStep 1:
Download the \nbinary tarball for Linux\n\n\nStep 2: Change to the root
directory: \n\n\n$cd / \n\n\n\n\n\n\nStep 3: Untar the tarball and install into
\n /usr/local/bin\n. You will need to replace \n ~/Downloads \n with the
directory that the tarball is downloaded to. \n\n\n Note:\n You must specify
the -p option for the tar command.\n\n\n$sudo tar -xpf
~/Downloads/openocd-bin-0.10.0-Linux.tgz\n\n\n\n\n\n\nStep 4: Check the OpenOCD
version you are using: \n\n\n$which openocd\n/usr/local/bin/openocd\n$openocd
-v\nOpen On-Chip Debugger 0.10.0\nLicensed under GNU GPL v2\nFor bug reports,
read\nhttp://openocd.org/doc/doxygen/bugs.html\n\n\n\n\n\nYou should see
version: \n0.10.0\n. \n\n\nIf you see any of these error
messages:\n\n\n\n\n\n\nopenocd: error while loading shared libraries:
libhidapi-hidraw.so.0: cannot open shared object file: No such file or
directory\n\n\n\n\n\n\nopenocd: error while loading shared libraries:
libusb-1.0.so.0: cannot open shared object file: No such file or directory
\n\n\n\n\n\n\nrun the following command to install the libraries: \n\n\n$sudo
apt-get install libhidapi-dev:i386\n\n\n\n\n\n\n\nInstalling OpenOCD on
Windows\n\n\nStep 1: Download the \nbinary zip file for Windows\n.\n\n\nStep 2:
Extract into the \nC:\\openocd-0.10.0\n folder. \n\n\nStep 3: Add the path: \n
C:\\openocd-0.10.0\\bin\n to your Windows User \nPath\n environment variable.
Note: You must add \nbin\n to the path.\n\n\nStep 4: Check the OpenOCD version
you are using. Open a new MinGW terminal and run the following commands:
\n\n\nNote:\n You must start a new MinGW terminal to inherit the new \nPath\n
values.\n\n\n$which openocd\n/c/openocd-0.10.0/bin/openocd\n$openocd -v\nOpen
On-Chip Debugger 0.10.0\nLicensed under GNU GPL v2\nFor bug reports, read\n
http://openocd.org/doc/doxygen/bugs.html\n\n\n\n\n\nYou should see version:
\n0.10.0\n. \n\n\n\n\nInstalling SEGGER J-Link\n\n\nYou can download and
install Segger J-LINK Software and documentation pack from \nSEGGER\n.
\n\n\nNote:\n On Windows, perform the following additonal steps:\n\n\n\n\nMake
note of the destination folder of your installation.\n\n\nAdd the installation
destination folder path to your Windows user \nPath\n environment variable.
You do not need to add \nbin\n to the path.\n\n\nOpen a new MinGW terminal to
inherit the new \nPath\n values.",
"title": "Install Cross Tools for ARM"
},
{
@@ -352,7 +352,7 @@
},
{
"location":
"/os/get_started/cross_tools/#installing-the-arm-toolchain-for-linux",
- "text": "On a Debian-based Linux distribution, gcc 4.9.3 for ARM
can be installed with\napt-get as documented below. The steps are explained in
depth at https://launchpad.net/~team-gcc-arm-embedded/+archive/ubuntu/ppa . $
sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi \n$ sudo
add-apt-repository ppa:team-gcc-arm-embedded/ppa\n$ sudo apt-get update \n$
sudo apt-get install gcc-arm-none-eabi\n$ sudo apt-get install
gdb-arm-none-eabi",
+ "text": "On a Debian-based Linux distribution, gcc 4.9.3 for ARM
can be installed with\napt-get as documented below. The steps are explained in
depth at https://launchpad.net/~team-gcc-arm-embedded/+archive/ubuntu/ppa . $
sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi \n$ sudo
add-apt-repository ppa:team-gcc-arm-embedded/ppa\n$ sudo apt-get update \n$
sudo apt-get install gcc-arm-embedded",
"title": "Installing the ARM Toolchain For Linux"
},
{
@@ -7382,7 +7382,7 @@
},
{
"location": "/os/modules/fs/fs/fsutil_read_file/",
- "text": "fsutil_read_file\n\n\nint\n
\nfsutil_read_file\n(\nconst\n \nchar\n \n*path\n, \nuint32_t\n \noffset\n,
\nuint32_t\n \nlen\n,\n \nvoid\n \n*dst\n, \nuint32_t\n
\n*out_len\n)\n\n\n\n\n\nCalls fs_open(), fs_read(), and fs_close() to open a
file at the specified path, retrieve data from the file starting from the
specified offset, and close the file and invalidate the file
handle.\n\n\nArguments\n\n\n\n\n\n\n\n\nArgument\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\npath\n\n\nPointer
to the directory entry to query\n\n\n\n\n\n\noffset\n\n\nPosition of the
file's read pointer\n\n\n\n\n\n\nlen\n\n\nNumber of bytes to attempt to
read\n\n\n\n\n\n\ndst\n\n\nDestination buffer to read
into\n\n\n\n\n\n\nout_len\n\n\nOn success, the number of bytes actually read
gets written here. Pass null if you don't care.\n\n\n\n\n\n\n\n\nReturned
values\n\n\n\n\n0 on success\n\n\nFS error code\n on
failure\n\n\n\n\nNotes\n\n\nThis is a convenience function. It is useful when
the amount of data to be read from the file is small (i.e., all the data read
can easily fit in a single buffer).\n\n\nHeader file\n\n\n#include\n
\nfs/fs.h\n\n\n\n\n\n\nExample\n\n\nThis example demonstrates reading a small
text file in its entirety and printing its contents to the
console.\n\n\nint\n\n\nprint_status\n(\nvoid\n)\n{\n \nuint32_t\n
\nbytes_read\n;\n \nuint8_t\n \nbuf\n[\n16\n];\n \nint\n \nrc\n;\n\n
\n/* Read up to 15 bytes from the start of the file. */\n\n \nrc\n \n=\n
\nfsutil_read_file\n(\n/cfg/status.txt\n, \n0\n, \nsizeof\n \nbuf\n \n-\n
\n1\n, \nbuf\n,\n \nbytes_read\n);\n \nif\n (\nrc\n
\n!=\n \n0\n) \nreturn\n \n-\n1\n;\n\n \n/* Null-terminate the string just
read. */\n\n \nbuf\n[\nbytes_read\n] \n=\n \n\\0\n;\n\n \n/* Print the
file contents to the console. */\n\n \nconsole_printf\n(\n%s\\n\n,
\nbuf\n);\n\n \nreturn\n \n0\n;\n}",
+ "text": "fsutil_read_file\n\n\nint\n
\nfsutil_read_file\n(\nconst\n \nchar\n \n*path\n, \nuint32_t\n \noffset\n,
\nuint32_t\n \nlen\n,\n \nvoid\n \n*dst\n, \nuint32_t\n
\n*out_len\n)\n\n\n\n\n\nCalls fs_open(), fs_read(), and fs_close() to open a
file at the specified path, retrieve data from the file starting from the
specified offset, and close the file and invalidate the file
handle.\n\n\nArguments\n\n\n\n\n\n\n\n\nArgument\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\npath\n\n\nPointer
to the directory entry to query\n\n\n\n\n\n\noffset\n\n\nPosition of the
file's read pointer\n\n\n\n\n\n\nlen\n\n\nNumber of bytes to attempt to
read\n\n\n\n\n\n\ndst\n\n\nDestination buffer to read
into\n\n\n\n\n\n\nout_len\n\n\nOn success, the number of bytes actually read
gets written here. Pass null if you don't care.\n\n\n\n\n\n\n\n\nReturned
values\n\n\n\n\n0 on success\n\n\nFS error code\n on
failure\n\n\n\n\nNotes\n\n\nThis is a convenience function. It is useful when
the amount of data to be read from the file is small (i.e., all the data read
can easily fit in a single buffer).\n\n\nHeader file\n\n\n#include\n
\nfs/fsutil.h\n\n\n\n\n\n\nExample\n\n\nThis example demonstrates reading a
small text file in its entirety and printing its contents to the
console.\n\n\nint\n\n\nprint_status\n(\nvoid\n)\n{\n \nuint32_t\n
\nbytes_read\n;\n \nuint8_t\n \nbuf\n[\n16\n];\n \nint\n \nrc\n;\n\n
\n/* Read up to 15 bytes from the start of the file. */\n\n \nrc\n \n=\n
\nfsutil_read_file\n(\n/cfg/status.txt\n, \n0\n, \nsizeof\n \nbuf\n \n-\n
\n1\n, \nbuf\n,\n \nbytes_read\n);\n \nif\n (\nrc\n
\n!=\n \n0\n) \nreturn\n \n-\n1\n;\n\n \n/* Null-terminate the string just
read. */\n\n \nbuf\n[\nbytes_read\n] \n=\n \n\\0\n;\n\n \n/* Print the
file contents to the console. */\n\n \nconsole_printf\n(\n%s\\n\n,
\nbuf\n);\n\n \nreturn\n \n0\n;\n}",
"title": "fsutil_read_file"
},
{
@@ -7407,7 +7407,7 @@
},
{
"location": "/os/modules/fs/fs/fsutil_read_file/#header-file",
- "text": "#include fs/fs.h",
+ "text": "#include fs/fsutil.h",
"title": "Header file"
},
{
@@ -7417,7 +7417,7 @@
},
{
"location": "/os/modules/fs/fs/fsutil_write_file/",
- "text": "fsutil_write_file\n\n\nint\n
\nfsutil_write_file\n(\nconst\n \nchar\n \n*path\n, \nconst\n \nvoid\n
\n*data\n, \nuint32_t\n \nlen\n)\n\n\n\n\n\nCalls fs_open(), fs_write(), and
fs_close() to open a file at the specified path, write the supplied data to the
current offset of the specified file handle, and close the file and invalidate
the file handle. If the specified file already exists, it is truncated and
overwritten with the specified
data.\n\n\nArguments\n\n\n\n\n\n\n\n\nArgument\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\npath\n\n\nPointer
to the file to write to\n\n\n\n\n\n\ndata\n\n\nThe data to
write\n\n\n\n\n\n\nlen\n\n\nThe number of bytes to
write\n\n\n\n\n\n\n\n\nReturned values\n\n\n\n\n0 on success\n\n\nFS error
code\n on failure\n\n\n\n\nHeader file\n\n\n#include\n
\nfs/fs.h\n\n\n\n\n\n\nExample\n\n\nThis example creates a 4-byte
file.\n\n\nint\n\n\nwrite_id\n(\nvoid\n)\n{\n \nint\n \nrc\n;\n\n \n/*
Create the parent directory. */\n\n \nrc\n \n=\n \nfs_mkdir\n(\n/cfg\n);\n
\nif\n (\nrc\n \n!=\n \n0\n \n \nrc\n \n!=\n \nFS_EALREADY\n) {\n
\nreturn\n \n-\n1\n;\n }\n\n \n/* Create a file and write four bytes to
it. */\n\n \nrc\n \n=\n \nfsutil_write_file\n(\n/cfg/id.txt\n, \n1234\n,
\n4\n);\n \nif\n (\nrc\n \n!=\n \n0\n) {\n \nreturn\n \n-\n1\n;\n
}\n\n \nreturn\n \n0\n;\n}",
+ "text": "fsutil_write_file\n\n\nint\n
\nfsutil_write_file\n(\nconst\n \nchar\n \n*path\n, \nconst\n \nvoid\n
\n*data\n, \nuint32_t\n \nlen\n)\n\n\n\n\n\nCalls fs_open(), fs_write(), and
fs_close() to open a file at the specified path, write the supplied data to the
current offset of the specified file handle, and close the file and invalidate
the file handle. If the specified file already exists, it is truncated and
overwritten with the specified
data.\n\n\nArguments\n\n\n\n\n\n\n\n\nArgument\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\npath\n\n\nPointer
to the file to write to\n\n\n\n\n\n\ndata\n\n\nThe data to
write\n\n\n\n\n\n\nlen\n\n\nThe number of bytes to
write\n\n\n\n\n\n\n\n\nReturned values\n\n\n\n\n0 on success\n\n\nFS error
code\n on failure\n\n\n\n\nHeader file\n\n\n#include\n
\nfs/fsutil.h\n\n\n\n\n\n\nExample\n\n\nThis example creates a 4-byte
file.\n\n\nint\n\n\nwrite_id\n(\nvoid\n)\n{\n \nint\n \nrc\n;\n\n \n/*
Create the parent directory. */\n\n \nrc\n \n=\n \nfs_mkdir\n(\n/cfg\n);\n
\nif\n (\nrc\n \n!=\n \n0\n \n \nrc\n \n!=\n \nFS_EALREADY\n) {\n
\nreturn\n \n-\n1\n;\n }\n\n \n/* Create a file and write four bytes to
it. */\n\n \nrc\n \n=\n \nfsutil_write_file\n(\n/cfg/id.txt\n, \n1234\n,
\n4\n);\n \nif\n (\nrc\n \n!=\n \n0\n) {\n \nreturn\n \n-\n1\n;\n
}\n\n \nreturn\n \n0\n;\n}",
"title": "fsutil_write_file"
},
{
@@ -7437,7 +7437,7 @@
},
{
"location": "/os/modules/fs/fs/fsutil_write_file/#header-file",
- "text": "#include fs/fs.h",
+ "text": "#include fs/fsutil.h",
"title": "Header file"
},
{
diff --git a/master/os/get_started/cross_tools/index.html
b/master/os/get_started/cross_tools/index.html
index f66a9b1ec..d52dfe0eb 100644
--- a/master/os/get_started/cross_tools/index.html
+++ b/master/os/get_started/cross_tools/index.html
@@ -495,8 +495,7 @@ <h3 id="installing-the-arm-toolchain-for-linux">Installing
the ARM Toolchain For
<div class="codehilite" style="background: #ffffff"><pre style="line-height:
125%"><span></span>$ sudo apt-get remove binutils-arm-none-eabi
gcc-arm-none-eabi
$ sudo add-apt-repository ppa:team-gcc-arm-embedded/ppa
$ sudo apt-get update
-$ sudo apt-get install gcc-arm-none-eabi
-$ sudo apt-get install gdb-arm-none-eabi
+$ sudo apt-get install gcc-arm-embedded
</pre></div>
diff --git a/master/os/modules/fs/fs/fsutil_read_file/index.html
b/master/os/modules/fs/fs/fsutil_read_file/index.html
index f2fffc048..06dcfc686 100644
--- a/master/os/modules/fs/fs/fsutil_read_file/index.html
+++ b/master/os/modules/fs/fs/fsutil_read_file/index.html
@@ -868,7 +868,7 @@ <h4 id="returned-values">Returned values</h4>
<h4 id="notes">Notes</h4>
<p>This is a convenience function. It is useful when the amount of data to be
read from the file is small (i.e., all the data read can easily fit in a single
buffer).</p>
<h4 id="header-file">Header file</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height:
125%"><span></span><span style="color: #633820">#include</span> <span
style="color: #177500">"fs/fs.h"</span><span style="color:
#633820"></span>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height:
125%"><span></span><span style="color: #633820">#include</span> <span
style="color: #177500">"fs/fsutil.h"</span><span style="color:
#633820"></span>
</pre></div>
diff --git a/master/os/modules/fs/fs/fsutil_write_file/index.html
b/master/os/modules/fs/fs/fsutil_write_file/index.html
index 6dfc52698..8378cc6ca 100644
--- a/master/os/modules/fs/fs/fsutil_write_file/index.html
+++ b/master/os/modules/fs/fs/fsutil_write_file/index.html
@@ -857,7 +857,7 @@ <h4 id="returned-values">Returned values</h4>
<li><a href="../fs_return_codes/">FS error code</a> on failure</li>
</ul>
<h4 id="header-file">Header file</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height:
125%"><span></span><span style="color: #633820">#include</span> <span
style="color: #177500">"fs/fs.h"</span><span style="color:
#633820"></span>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height:
125%"><span></span><span style="color: #633820">#include</span> <span
style="color: #177500">"fs/fsutil.h"</span><span style="color:
#633820"></span>
</pre></div>
diff --git a/mkdocs/search_index.json b/mkdocs/search_index.json
index ae688f2bc..bfdd02138 100644
--- a/mkdocs/search_index.json
+++ b/mkdocs/search_index.json
@@ -332,7 +332,7 @@
},
{
"location": "/os/get_started/cross_tools/",
- "text": "Installing the Cross Tools for ARM\n\n\nThis page shows
you how to install the tools to build, run, and debug Mynewt OS applications
that run on supported ARM target boards. It shows you how to install the
following tools on Mac OS, Linux and Windows:\n\n\n\n\nARM cross toolchain to
compile and build Mynewt applications for the target boards.\n\n\nDebuggers to
load and debug applications on the target boards.\n\n\n\n\n\n\nInstalling the
ARM Cross Toolchain\n\n\nARM maintains a pre-built GNU toolchain with gcc and
gdb targeted at Embedded ARM Processors, namely Cortex-R/Cortex-M processor
families. Mynewt OS has been tested with version 4.9 of the toolchain and we
recommend you install this version to get started. Mynewt OS will eventually
work with multiple versions available, including the latest releases.
\n\n\nInstalling the ARM Toolchain For Mac OS X\n\n\nAdd the
\nPX4/homebrew-px4\n homebrew tap and install version 4.9 of the toolchain.
After installing, check that the symbolic link that homebrew created points to
the correct version of the debugger.\n\n\n$ brew tap PX4/homebrew-px4\n$ brew
update\n$ brew install gcc-arm-none-eabi-49\n$ arm-none-eabi-gcc --version
\narm-none-eabi-gcc (GNU Tools for ARM Embedded Processors) 4.9.3 20150529
(release) [ARM/embedded-4_9-branch revision 224288]\nCopyright (C) 2014 Free
Software Foundation, Inc.\nThis is free software; see the source for copying
conditions. There is NO\nwarranty; not even for MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.\n$ ls -al /usr/local/bin/arm-none-eabi-gdb\nlrwxr-xr-x 1
aditihilbert admin 69 Sep 22 17:16 /usr/local/bin/arm-none-eabi-gdb -\n
/usr/local/Cellar/gcc-arm-none-eabi-49/20150609/bin/arm-none-eabi-gdb\n\n\n\n\n\nNote:\n
If no version is specified, brew will install the latest version available.
\n\n\n\n\nInstalling the ARM Toolchain For Linux\n\n\nOn a Debian-based Linux
distribution, gcc 4.9.3 for ARM can be installed with\napt-get as documented
below. The steps are explained in depth
at\n\nhttps://launchpad.net/~team-gcc-arm-embedded/+archive/ubuntu/ppa\n.\n\n\n$
sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi \n$ sudo
add-apt-repository ppa:team-gcc-arm-embedded/ppa\n$ sudo apt-get update \n$
sudo apt-get install gcc-arm-none-eabi\n$ sudo apt-get install
gdb-arm-none-eabi\n\n\n\n\n\n\n\nInstalling the ARM Toolchain for
Windows\n\n\nStep 1: Download and run the \ninstaller\n to install
arm-none-eabi-gcc and arm-none-eabi-gdb. Select the default destination folder:
\nC:\\Program Files (x86)\\GNU Tools ARM Embedded\\4.9 2015q2\n. \n\n\nNotes:\n
\n\n\n\n\nCheck the \nAdd path to environment variable\n option before you
click the \nFinish\n button for the installation. \n\n\nYou may select a
different folder but the installation instructions use the default
values.\n\n\n\n\nStep 2: Check that you are using the installed versions
arm-none-eabi-gcc and arm-none-eabi-gdb. Open a MinGW terminal and run the
\nwhich\n commands. \n\n\nNote:\n You must start a new MinGW terminal to
inherit the new \nPath\n values.\n\n\n$ which arm-none-eabi-gcc\n/c/Program
Files (x86)/GNU Tools ARM Embedded/4.9 2015q2/bin/arm-none-eabi-gcc\n$which
arm-none-eabi-gdb\n/c/Program Files (x86)/GNU Tools ARM Embedded/4.9
2015q2/bin/arm-none-eabi-gdb\n\n\n\n\n\nInstalling the Debuggers\n\n\nMynewt
uses, depending on the board, either the OpenOCD or SEGGER J-Link debuggers.
\n\n\n\nInstalling the OpenOCD Debugger\n\n\nOpenOCD (Open On-Chip Debugger) is
open-source software that allows your\ncomputer to interface with the JTAG
debug connector on a variety of boards. A\nJTAG connection lets you debug and
test embedded target devices. For more on\nOpenOCD go to
\nhttp://openocd.org\n.\n\n\nOpenOCD version 0.10.0 with nrf52 support is
required. A binary for this version is available to download for Mac OS,
Linux, and Windows.\n\n\n\n\nInstalling OpenOCD on Mac OS\n\n\nStep 1: Download
the \nbinary tarball for Mac OS\n.\n\n\nStep 2: Change to the root directory:
\n\n\n$cd / \n\n\n\n\n\n\nStep 3: Untar the tarball and install into \n
/usr/local/bin\n. You will need to replace \n ~/Downloads \n with the
directory that the tarball is downloaded to. \n\n\nsudo tar -xf
~/Downloads/openocd-bin-0.10.0-MacOS.tgz\n\n\n\n\n\n\nStep 4: Check the OpenOCD
version you are using. \n\n\n$which openocd\n/usr/local/bin/openocd\n$openocd
-v\nOpen On-Chip Debugger 0.10.0\nLicensed under GNU GPL v2\nFor bug reports,
read\nhttp://openocd.org/doc/doxygen/bugs.html\n\n\n\n\n\nYou should see
version: \n0.10.0\n. \n\n\nIf you see one of these errors:\n\n\n\n\nLibrary not
loaded: /usr/local/lib/libusb-0.1.4.dylib - Run \nbrew install
libusb-compat\n.\n\n\nLibrary not loaded:
/usr/local/opt/libftdi/lib/libftdi1.2.dylib - Run \nbrew install
libftdi\n.\n\n\nLibrary not loaded: /usr/local/lib/libhidapi.0.dylib - Run
\nbrew install hidapi\n.\n\n\n\n\n\n\nInstalling OpenOCD on Linux\n\n\nStep 1:
Download the \nbinary tarball for Linux\n\n\nStep 2: Change to the root
directory: \n\n\n$cd / \n\n\n\n\n\n\nStep 3: Untar the tarball and install into
\n /usr/local/bin\n. You will need to replace \n ~/Downloads \n with the
directory that the tarball is downloaded to. \n\n\n Note:\n You must specify
the -p option for the tar command.\n\n\n$sudo tar -xpf
~/Downloads/openocd-bin-0.10.0-Linux.tgz\n\n\n\n\n\n\nStep 4: Check the OpenOCD
version you are using: \n\n\n$which openocd\n/usr/local/bin/openocd\n$openocd
-v\nOpen On-Chip Debugger 0.10.0\nLicensed under GNU GPL v2\nFor bug reports,
read\nhttp://openocd.org/doc/doxygen/bugs.html\n\n\n\n\n\nYou should see
version: \n0.10.0\n. \n\n\nIf you see any of these error
messages:\n\n\n\n\n\n\nopenocd: error while loading shared libraries:
libhidapi-hidraw.so.0: cannot open shared object file: No such file or
directory\n\n\n\n\n\n\nopenocd: error while loading shared libraries:
libusb-1.0.so.0: cannot open shared object file: No such file or directory
\n\n\n\n\n\n\nrun the following command to install the libraries: \n\n\n$sudo
apt-get install libhidapi-dev:i386\n\n\n\n\n\n\n\nInstalling OpenOCD on
Windows\n\n\nStep 1: Download the \nbinary zip file for Windows\n.\n\n\nStep 2:
Extract into the \nC:\\openocd-0.10.0\n folder. \n\n\nStep 3: Add the path: \n
C:\\openocd-0.10.0\\bin\n to your Windows User \nPath\n environment variable.
Note: You must add \nbin\n to the path.\n\n\nStep 4: Check the OpenOCD version
you are using. Open a new MinGW terminal and run the following commands:
\n\n\nNote:\n You must start a new MinGW terminal to inherit the new \nPath\n
values.\n\n\n$which openocd\n/c/openocd-0.10.0/bin/openocd\n$openocd -v\nOpen
On-Chip Debugger 0.10.0\nLicensed under GNU GPL v2\nFor bug reports, read\n
http://openocd.org/doc/doxygen/bugs.html\n\n\n\n\n\nYou should see version:
\n0.10.0\n. \n\n\n\n\nInstalling SEGGER J-Link\n\n\nYou can download and
install Segger J-LINK Software and documentation pack from \nSEGGER\n.
\n\n\nNote:\n On Windows, perform the following additonal steps:\n\n\n\n\nMake
note of the destination folder of your installation.\n\n\nAdd the installation
destination folder path to your Windows user \nPath\n environment variable.
You do not need to add \nbin\n to the path.\n\n\nOpen a new MinGW terminal to
inherit the new \nPath\n values.",
+ "text": "Installing the Cross Tools for ARM\n\n\nThis page shows
you how to install the tools to build, run, and debug Mynewt OS applications
that run on supported ARM target boards. It shows you how to install the
following tools on Mac OS, Linux and Windows:\n\n\n\n\nARM cross toolchain to
compile and build Mynewt applications for the target boards.\n\n\nDebuggers to
load and debug applications on the target boards.\n\n\n\n\n\n\nInstalling the
ARM Cross Toolchain\n\n\nARM maintains a pre-built GNU toolchain with gcc and
gdb targeted at Embedded ARM Processors, namely Cortex-R/Cortex-M processor
families. Mynewt OS has been tested with version 4.9 of the toolchain and we
recommend you install this version to get started. Mynewt OS will eventually
work with multiple versions available, including the latest releases.
\n\n\nInstalling the ARM Toolchain For Mac OS X\n\n\nAdd the
\nPX4/homebrew-px4\n homebrew tap and install version 4.9 of the toolchain.
After installing, check that the symbolic link that homebrew created points to
the correct version of the debugger.\n\n\n$ brew tap PX4/homebrew-px4\n$ brew
update\n$ brew install gcc-arm-none-eabi-49\n$ arm-none-eabi-gcc --version
\narm-none-eabi-gcc (GNU Tools for ARM Embedded Processors) 4.9.3 20150529
(release) [ARM/embedded-4_9-branch revision 224288]\nCopyright (C) 2014 Free
Software Foundation, Inc.\nThis is free software; see the source for copying
conditions. There is NO\nwarranty; not even for MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.\n$ ls -al /usr/local/bin/arm-none-eabi-gdb\nlrwxr-xr-x 1
aditihilbert admin 69 Sep 22 17:16 /usr/local/bin/arm-none-eabi-gdb -\n
/usr/local/Cellar/gcc-arm-none-eabi-49/20150609/bin/arm-none-eabi-gdb\n\n\n\n\n\nNote:\n
If no version is specified, brew will install the latest version available.
\n\n\n\n\nInstalling the ARM Toolchain For Linux\n\n\nOn a Debian-based Linux
distribution, gcc 4.9.3 for ARM can be installed with\napt-get as documented
below. The steps are explained in depth
at\n\nhttps://launchpad.net/~team-gcc-arm-embedded/+archive/ubuntu/ppa\n.\n\n\n$
sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi \n$ sudo
add-apt-repository ppa:team-gcc-arm-embedded/ppa\n$ sudo apt-get update \n$
sudo apt-get install gcc-arm-embedded\n\n\n\n\n\n\n\nInstalling the ARM
Toolchain for Windows\n\n\nStep 1: Download and run the \ninstaller\n to
install arm-none-eabi-gcc and arm-none-eabi-gdb. Select the default destination
folder: \nC:\\Program Files (x86)\\GNU Tools ARM Embedded\\4.9 2015q2\n.
\n\n\nNotes:\n \n\n\n\n\nCheck the \nAdd path to environment variable\n option
before you click the \nFinish\n button for the installation. \n\n\nYou may
select a different folder but the installation instructions use the default
values.\n\n\n\n\nStep 2: Check that you are using the installed versions
arm-none-eabi-gcc and arm-none-eabi-gdb. Open a MinGW terminal and run the
\nwhich\n commands. \n\n\nNote:\n You must start a new MinGW terminal to
inherit the new \nPath\n values.\n\n\n$ which arm-none-eabi-gcc\n/c/Program
Files (x86)/GNU Tools ARM Embedded/4.9 2015q2/bin/arm-none-eabi-gcc\n$which
arm-none-eabi-gdb\n/c/Program Files (x86)/GNU Tools ARM Embedded/4.9
2015q2/bin/arm-none-eabi-gdb\n\n\n\n\n\nInstalling the Debuggers\n\n\nMynewt
uses, depending on the board, either the OpenOCD or SEGGER J-Link debuggers.
\n\n\n\nInstalling the OpenOCD Debugger\n\n\nOpenOCD (Open On-Chip Debugger) is
open-source software that allows your\ncomputer to interface with the JTAG
debug connector on a variety of boards. A\nJTAG connection lets you debug and
test embedded target devices. For more on\nOpenOCD go to
\nhttp://openocd.org\n.\n\n\nOpenOCD version 0.10.0 with nrf52 support is
required. A binary for this version is available to download for Mac OS,
Linux, and Windows.\n\n\n\n\nInstalling OpenOCD on Mac OS\n\n\nStep 1: Download
the \nbinary tarball for Mac OS\n.\n\n\nStep 2: Change to the root directory:
\n\n\n$cd / \n\n\n\n\n\n\nStep 3: Untar the tarball and install into \n
/usr/local/bin\n. You will need to replace \n ~/Downloads \n with the
directory that the tarball is downloaded to. \n\n\nsudo tar -xf
~/Downloads/openocd-bin-0.10.0-MacOS.tgz\n\n\n\n\n\n\nStep 4: Check the OpenOCD
version you are using. \n\n\n$which openocd\n/usr/local/bin/openocd\n$openocd
-v\nOpen On-Chip Debugger 0.10.0\nLicensed under GNU GPL v2\nFor bug reports,
read\nhttp://openocd.org/doc/doxygen/bugs.html\n\n\n\n\n\nYou should see
version: \n0.10.0\n. \n\n\nIf you see one of these errors:\n\n\n\n\nLibrary not
loaded: /usr/local/lib/libusb-0.1.4.dylib - Run \nbrew install
libusb-compat\n.\n\n\nLibrary not loaded:
/usr/local/opt/libftdi/lib/libftdi1.2.dylib - Run \nbrew install
libftdi\n.\n\n\nLibrary not loaded: /usr/local/lib/libhidapi.0.dylib - Run
\nbrew install hidapi\n.\n\n\n\n\n\n\nInstalling OpenOCD on Linux\n\n\nStep 1:
Download the \nbinary tarball for Linux\n\n\nStep 2: Change to the root
directory: \n\n\n$cd / \n\n\n\n\n\n\nStep 3: Untar the tarball and install into
\n /usr/local/bin\n. You will need to replace \n ~/Downloads \n with the
directory that the tarball is downloaded to. \n\n\n Note:\n You must specify
the -p option for the tar command.\n\n\n$sudo tar -xpf
~/Downloads/openocd-bin-0.10.0-Linux.tgz\n\n\n\n\n\n\nStep 4: Check the OpenOCD
version you are using: \n\n\n$which openocd\n/usr/local/bin/openocd\n$openocd
-v\nOpen On-Chip Debugger 0.10.0\nLicensed under GNU GPL v2\nFor bug reports,
read\nhttp://openocd.org/doc/doxygen/bugs.html\n\n\n\n\n\nYou should see
version: \n0.10.0\n. \n\n\nIf you see any of these error
messages:\n\n\n\n\n\n\nopenocd: error while loading shared libraries:
libhidapi-hidraw.so.0: cannot open shared object file: No such file or
directory\n\n\n\n\n\n\nopenocd: error while loading shared libraries:
libusb-1.0.so.0: cannot open shared object file: No such file or directory
\n\n\n\n\n\n\nrun the following command to install the libraries: \n\n\n$sudo
apt-get install libhidapi-dev:i386\n\n\n\n\n\n\n\nInstalling OpenOCD on
Windows\n\n\nStep 1: Download the \nbinary zip file for Windows\n.\n\n\nStep 2:
Extract into the \nC:\\openocd-0.10.0\n folder. \n\n\nStep 3: Add the path: \n
C:\\openocd-0.10.0\\bin\n to your Windows User \nPath\n environment variable.
Note: You must add \nbin\n to the path.\n\n\nStep 4: Check the OpenOCD version
you are using. Open a new MinGW terminal and run the following commands:
\n\n\nNote:\n You must start a new MinGW terminal to inherit the new \nPath\n
values.\n\n\n$which openocd\n/c/openocd-0.10.0/bin/openocd\n$openocd -v\nOpen
On-Chip Debugger 0.10.0\nLicensed under GNU GPL v2\nFor bug reports, read\n
http://openocd.org/doc/doxygen/bugs.html\n\n\n\n\n\nYou should see version:
\n0.10.0\n. \n\n\n\n\nInstalling SEGGER J-Link\n\n\nYou can download and
install Segger J-LINK Software and documentation pack from \nSEGGER\n.
\n\n\nNote:\n On Windows, perform the following additonal steps:\n\n\n\n\nMake
note of the destination folder of your installation.\n\n\nAdd the installation
destination folder path to your Windows user \nPath\n environment variable.
You do not need to add \nbin\n to the path.\n\n\nOpen a new MinGW terminal to
inherit the new \nPath\n values.",
"title": "Install Cross Tools for ARM"
},
{
@@ -352,7 +352,7 @@
},
{
"location":
"/os/get_started/cross_tools/#installing-the-arm-toolchain-for-linux",
- "text": "On a Debian-based Linux distribution, gcc 4.9.3 for ARM
can be installed with\napt-get as documented below. The steps are explained in
depth at https://launchpad.net/~team-gcc-arm-embedded/+archive/ubuntu/ppa . $
sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi \n$ sudo
add-apt-repository ppa:team-gcc-arm-embedded/ppa\n$ sudo apt-get update \n$
sudo apt-get install gcc-arm-none-eabi\n$ sudo apt-get install
gdb-arm-none-eabi",
+ "text": "On a Debian-based Linux distribution, gcc 4.9.3 for ARM
can be installed with\napt-get as documented below. The steps are explained in
depth at https://launchpad.net/~team-gcc-arm-embedded/+archive/ubuntu/ppa . $
sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi \n$ sudo
add-apt-repository ppa:team-gcc-arm-embedded/ppa\n$ sudo apt-get update \n$
sudo apt-get install gcc-arm-embedded",
"title": "Installing the ARM Toolchain For Linux"
},
{
@@ -7382,7 +7382,7 @@
},
{
"location": "/os/modules/fs/fs/fsutil_read_file/",
- "text": "fsutil_read_file\n\n\nint\n
\nfsutil_read_file\n(\nconst\n \nchar\n \n*path\n, \nuint32_t\n \noffset\n,
\nuint32_t\n \nlen\n,\n \nvoid\n \n*dst\n, \nuint32_t\n
\n*out_len\n)\n\n\n\n\n\nCalls fs_open(), fs_read(), and fs_close() to open a
file at the specified path, retrieve data from the file starting from the
specified offset, and close the file and invalidate the file
handle.\n\n\nArguments\n\n\n\n\n\n\n\n\nArgument\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\npath\n\n\nPointer
to the directory entry to query\n\n\n\n\n\n\noffset\n\n\nPosition of the
file's read pointer\n\n\n\n\n\n\nlen\n\n\nNumber of bytes to attempt to
read\n\n\n\n\n\n\ndst\n\n\nDestination buffer to read
into\n\n\n\n\n\n\nout_len\n\n\nOn success, the number of bytes actually read
gets written here. Pass null if you don't care.\n\n\n\n\n\n\n\n\nReturned
values\n\n\n\n\n0 on success\n\n\nFS error code\n on
failure\n\n\n\n\nNotes\n\n\nThis is a convenience function. It is useful when
the amount of data to be read from the file is small (i.e., all the data read
can easily fit in a single buffer).\n\n\nHeader file\n\n\n#include\n
\nfs/fs.h\n\n\n\n\n\n\nExample\n\n\nThis example demonstrates reading a small
text file in its entirety and printing its contents to the
console.\n\n\nint\n\n\nprint_status\n(\nvoid\n)\n{\n \nuint32_t\n
\nbytes_read\n;\n \nuint8_t\n \nbuf\n[\n16\n];\n \nint\n \nrc\n;\n\n
\n/* Read up to 15 bytes from the start of the file. */\n\n \nrc\n \n=\n
\nfsutil_read_file\n(\n/cfg/status.txt\n, \n0\n, \nsizeof\n \nbuf\n \n-\n
\n1\n, \nbuf\n,\n \nbytes_read\n);\n \nif\n (\nrc\n
\n!=\n \n0\n) \nreturn\n \n-\n1\n;\n\n \n/* Null-terminate the string just
read. */\n\n \nbuf\n[\nbytes_read\n] \n=\n \n\\0\n;\n\n \n/* Print the
file contents to the console. */\n\n \nconsole_printf\n(\n%s\\n\n,
\nbuf\n);\n\n \nreturn\n \n0\n;\n}",
+ "text": "fsutil_read_file\n\n\nint\n
\nfsutil_read_file\n(\nconst\n \nchar\n \n*path\n, \nuint32_t\n \noffset\n,
\nuint32_t\n \nlen\n,\n \nvoid\n \n*dst\n, \nuint32_t\n
\n*out_len\n)\n\n\n\n\n\nCalls fs_open(), fs_read(), and fs_close() to open a
file at the specified path, retrieve data from the file starting from the
specified offset, and close the file and invalidate the file
handle.\n\n\nArguments\n\n\n\n\n\n\n\n\nArgument\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\npath\n\n\nPointer
to the directory entry to query\n\n\n\n\n\n\noffset\n\n\nPosition of the
file's read pointer\n\n\n\n\n\n\nlen\n\n\nNumber of bytes to attempt to
read\n\n\n\n\n\n\ndst\n\n\nDestination buffer to read
into\n\n\n\n\n\n\nout_len\n\n\nOn success, the number of bytes actually read
gets written here. Pass null if you don't care.\n\n\n\n\n\n\n\n\nReturned
values\n\n\n\n\n0 on success\n\n\nFS error code\n on
failure\n\n\n\n\nNotes\n\n\nThis is a convenience function. It is useful when
the amount of data to be read from the file is small (i.e., all the data read
can easily fit in a single buffer).\n\n\nHeader file\n\n\n#include\n
\nfs/fsutil.h\n\n\n\n\n\n\nExample\n\n\nThis example demonstrates reading a
small text file in its entirety and printing its contents to the
console.\n\n\nint\n\n\nprint_status\n(\nvoid\n)\n{\n \nuint32_t\n
\nbytes_read\n;\n \nuint8_t\n \nbuf\n[\n16\n];\n \nint\n \nrc\n;\n\n
\n/* Read up to 15 bytes from the start of the file. */\n\n \nrc\n \n=\n
\nfsutil_read_file\n(\n/cfg/status.txt\n, \n0\n, \nsizeof\n \nbuf\n \n-\n
\n1\n, \nbuf\n,\n \nbytes_read\n);\n \nif\n (\nrc\n
\n!=\n \n0\n) \nreturn\n \n-\n1\n;\n\n \n/* Null-terminate the string just
read. */\n\n \nbuf\n[\nbytes_read\n] \n=\n \n\\0\n;\n\n \n/* Print the
file contents to the console. */\n\n \nconsole_printf\n(\n%s\\n\n,
\nbuf\n);\n\n \nreturn\n \n0\n;\n}",
"title": "fsutil_read_file"
},
{
@@ -7407,7 +7407,7 @@
},
{
"location": "/os/modules/fs/fs/fsutil_read_file/#header-file",
- "text": "#include fs/fs.h",
+ "text": "#include fs/fsutil.h",
"title": "Header file"
},
{
@@ -7417,7 +7417,7 @@
},
{
"location": "/os/modules/fs/fs/fsutil_write_file/",
- "text": "fsutil_write_file\n\n\nint\n
\nfsutil_write_file\n(\nconst\n \nchar\n \n*path\n, \nconst\n \nvoid\n
\n*data\n, \nuint32_t\n \nlen\n)\n\n\n\n\n\nCalls fs_open(), fs_write(), and
fs_close() to open a file at the specified path, write the supplied data to the
current offset of the specified file handle, and close the file and invalidate
the file handle. If the specified file already exists, it is truncated and
overwritten with the specified
data.\n\n\nArguments\n\n\n\n\n\n\n\n\nArgument\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\npath\n\n\nPointer
to the file to write to\n\n\n\n\n\n\ndata\n\n\nThe data to
write\n\n\n\n\n\n\nlen\n\n\nThe number of bytes to
write\n\n\n\n\n\n\n\n\nReturned values\n\n\n\n\n0 on success\n\n\nFS error
code\n on failure\n\n\n\n\nHeader file\n\n\n#include\n
\nfs/fs.h\n\n\n\n\n\n\nExample\n\n\nThis example creates a 4-byte
file.\n\n\nint\n\n\nwrite_id\n(\nvoid\n)\n{\n \nint\n \nrc\n;\n\n \n/*
Create the parent directory. */\n\n \nrc\n \n=\n \nfs_mkdir\n(\n/cfg\n);\n
\nif\n (\nrc\n \n!=\n \n0\n \n \nrc\n \n!=\n \nFS_EALREADY\n) {\n
\nreturn\n \n-\n1\n;\n }\n\n \n/* Create a file and write four bytes to
it. */\n\n \nrc\n \n=\n \nfsutil_write_file\n(\n/cfg/id.txt\n, \n1234\n,
\n4\n);\n \nif\n (\nrc\n \n!=\n \n0\n) {\n \nreturn\n \n-\n1\n;\n
}\n\n \nreturn\n \n0\n;\n}",
+ "text": "fsutil_write_file\n\n\nint\n
\nfsutil_write_file\n(\nconst\n \nchar\n \n*path\n, \nconst\n \nvoid\n
\n*data\n, \nuint32_t\n \nlen\n)\n\n\n\n\n\nCalls fs_open(), fs_write(), and
fs_close() to open a file at the specified path, write the supplied data to the
current offset of the specified file handle, and close the file and invalidate
the file handle. If the specified file already exists, it is truncated and
overwritten with the specified
data.\n\n\nArguments\n\n\n\n\n\n\n\n\nArgument\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\npath\n\n\nPointer
to the file to write to\n\n\n\n\n\n\ndata\n\n\nThe data to
write\n\n\n\n\n\n\nlen\n\n\nThe number of bytes to
write\n\n\n\n\n\n\n\n\nReturned values\n\n\n\n\n0 on success\n\n\nFS error
code\n on failure\n\n\n\n\nHeader file\n\n\n#include\n
\nfs/fsutil.h\n\n\n\n\n\n\nExample\n\n\nThis example creates a 4-byte
file.\n\n\nint\n\n\nwrite_id\n(\nvoid\n)\n{\n \nint\n \nrc\n;\n\n \n/*
Create the parent directory. */\n\n \nrc\n \n=\n \nfs_mkdir\n(\n/cfg\n);\n
\nif\n (\nrc\n \n!=\n \n0\n \n \nrc\n \n!=\n \nFS_EALREADY\n) {\n
\nreturn\n \n-\n1\n;\n }\n\n \n/* Create a file and write four bytes to
it. */\n\n \nrc\n \n=\n \nfsutil_write_file\n(\n/cfg/id.txt\n, \n1234\n,
\n4\n);\n \nif\n (\nrc\n \n!=\n \n0\n) {\n \nreturn\n \n-\n1\n;\n
}\n\n \nreturn\n \n0\n;\n}",
"title": "fsutil_write_file"
},
{
@@ -7437,7 +7437,7 @@
},
{
"location": "/os/modules/fs/fs/fsutil_write_file/#header-file",
- "text": "#include fs/fs.h",
+ "text": "#include fs/fsutil.h",
"title": "Header file"
},
{
diff --git a/os/get_started/cross_tools/index.html
b/os/get_started/cross_tools/index.html
index f66a9b1ec..d52dfe0eb 100644
--- a/os/get_started/cross_tools/index.html
+++ b/os/get_started/cross_tools/index.html
@@ -495,8 +495,7 @@ <h3 id="installing-the-arm-toolchain-for-linux">Installing
the ARM Toolchain For
<div class="codehilite" style="background: #ffffff"><pre style="line-height:
125%"><span></span>$ sudo apt-get remove binutils-arm-none-eabi
gcc-arm-none-eabi
$ sudo add-apt-repository ppa:team-gcc-arm-embedded/ppa
$ sudo apt-get update
-$ sudo apt-get install gcc-arm-none-eabi
-$ sudo apt-get install gdb-arm-none-eabi
+$ sudo apt-get install gcc-arm-embedded
</pre></div>
diff --git a/os/modules/fs/fs/fsutil_read_file/index.html
b/os/modules/fs/fs/fsutil_read_file/index.html
index f2fffc048..06dcfc686 100644
--- a/os/modules/fs/fs/fsutil_read_file/index.html
+++ b/os/modules/fs/fs/fsutil_read_file/index.html
@@ -868,7 +868,7 @@ <h4 id="returned-values">Returned values</h4>
<h4 id="notes">Notes</h4>
<p>This is a convenience function. It is useful when the amount of data to be
read from the file is small (i.e., all the data read can easily fit in a single
buffer).</p>
<h4 id="header-file">Header file</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height:
125%"><span></span><span style="color: #633820">#include</span> <span
style="color: #177500">"fs/fs.h"</span><span style="color:
#633820"></span>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height:
125%"><span></span><span style="color: #633820">#include</span> <span
style="color: #177500">"fs/fsutil.h"</span><span style="color:
#633820"></span>
</pre></div>
diff --git a/os/modules/fs/fs/fsutil_write_file/index.html
b/os/modules/fs/fs/fsutil_write_file/index.html
index 6dfc52698..8378cc6ca 100644
--- a/os/modules/fs/fs/fsutil_write_file/index.html
+++ b/os/modules/fs/fs/fsutil_write_file/index.html
@@ -857,7 +857,7 @@ <h4 id="returned-values">Returned values</h4>
<li><a href="../fs_return_codes/">FS error code</a> on failure</li>
</ul>
<h4 id="header-file">Header file</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height:
125%"><span></span><span style="color: #633820">#include</span> <span
style="color: #177500">"fs/fs.h"</span><span style="color:
#633820"></span>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height:
125%"><span></span><span style="color: #633820">#include</span> <span
style="color: #177500">"fs/fsutil.h"</span><span style="color:
#633820"></span>
</pre></div>
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
