Documentation ¶
Overview ¶
Package tree provides utility functions to manage the the NAOS build tree.
Package tree provides utility functions to manage the NAOS build tree.
Index ¶
- func AppBinary(naosPath string) ([]byte, error)
- func Attach(naosPath, port string, simple bool, out io.Writer, in io.Reader) error
- func BinDirectory(naosPath string) (string, error)
- func Build(naosPath string, clean, appOnly bool, out io.Writer) error
- func Config(naosPath string, values map[string]string, port string, out io.Writer) error
- func Directory(naosPath string) string
- func Exec(naosPath string, out io.Writer, in io.Reader, name string, arg ...string) error
- func Flash(naosPath, port string, erase, appOnly bool, out io.Writer) error
- func Format(naosPath string, out io.Writer) error
- func IDFDirectory(naosPath string) string
- func IncludeDirectories(naosPath string) ([]string, error)
- func Install(naosPath, sourcePath, version string, force bool, out io.Writer) error
- func InstallComponent(naosPath, name, repository, version string, force bool, out io.Writer) error
- func InstallToolchain(naosPath, version string, force bool, out io.Writer) error
- func ParseCoredump(naosPath string, coredump []byte) ([]byte, error)
- func RequiredToolchain(naosPath string) (string, error)
- func SourceAndHeaderFiles(naosPath string) ([]string, []string, error)
- func WriteCMakeLists(naosPath string, out io.Writer) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Attach ¶
Attach will attach to the specified serial port using either miniterm in simple mode or idf_monitor.
func BinDirectory ¶
BinDirectory returns the assumed location of the xtensa toolchain 'bin' directory.
Note: It will not check if the directory exists.
func Directory ¶
Directory returns the assumed location of the build tree directory.
Note: It will not check if the directory exists.
func Exec ¶
Exec runs a named command in the build tree. All xtensa toolchain binaries are made available in the path transparently.
func IDFDirectory ¶
IDFDirectory returns the assumed location of the esp-idf directory.
Note: It will not check if the directory exists.
func IncludeDirectories ¶
IncludeDirectories returns a list of directories that will be included in the build process.
func Install ¶
Install will install the NAOS repo to the specified path and link the source path into the build tree.
func InstallComponent ¶
InstallComponent will install the specified component in the build tree.
func InstallToolchain ¶
InstallToolchain will install the xtensa toolchain. An existing toolchain will be removed if force is set to true. If out is not nil, it will be used to log information about the installation process.
func ParseCoredump ¶
ParseCoredump will parse the provided raw coredump data and return a human readable representation.
func RequiredToolchain ¶
RequiredToolchain returns the required toolchain version by the current NAOS installation.
func SourceAndHeaderFiles ¶
SourceAndHeaderFiles will return a list of source and header files.
Types ¶
This section is empty.