Documentation ¶
Overview ¶
Package tree provides utility functions to manage the NAOS build tree.
Package tree provides utility functions to manage the NAOS build tree.
Index ¶
- func ADFDirectory(naosPath string) string
- func AppBinary(naosPath string) ([]byte, error)
- func Attach(naosPath, port string, out io.Writer, in io.Reader) error
- func BinDirectory(naosPath string) (string, error)
- func Build(naosPath, target string, overrides map[string]string, files []string, ...) 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, noEnv, usePty bool, name string, ...) error
- func Flash(naosPath, target, port, baudRate string, erase, appOnly, alt bool, ...) error
- func Format(naosPath string, out io.Writer) error
- func IDFDirectory(naosPath string) string
- func IDFMajorVersion(naosPath string) (int, error)
- func IDFVersion(naosPath string) (string, error)
- func IncludeDirectories(naosPath string) ([]string, error)
- func Install(naosPath, sourcePath, dataPath, version string, force bool, out io.Writer) error
- func InstallAudioFramework(naosPath, version string, force bool, out io.Writer) error
- func InstallComponent(projectPath, naosPath, name, path, repository, version string, force bool, ...) error
- func InstallToolchain(naosPath string, force bool, out io.Writer) error
- func InstallToolchain3(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 ADFDirectory ¶ added in v0.10.0
ADFDirectory returns the assumed location of the esp-adf directory.
Note: It will not check if the directory exists.
func BinDirectory ¶
BinDirectory returns the assumed location of the xtensa toolchain 'bin' directory.
Note: It will not check if the directory exists.
func Build ¶
func Build(naosPath, target string, overrides map[string]string, files []string, clean, reconfigure, appOnly bool, out io.Writer) error
Build will build the project.
func Directory ¶
Directory returns the assumed location of the build tree directory.
Note: It will not check if the directory exists.
func Exec ¶
func Exec(naosPath string, out io.Writer, in io.Reader, noEnv, usePty bool, name string, arg ...string) error
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 IDFMajorVersion ¶ added in v0.9.0
IDFMajorVersion will detect and return the major IDF version from the specified path.
func IDFVersion ¶ added in v0.11.0
IDFVersion will detect and return the IDF version from the specified path.
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 InstallAudioFramework ¶ added in v0.10.0
InstallAudioFramework will manage the esp-adf installation.
func InstallComponent ¶
func InstallComponent(projectPath, naosPath, name, path, repository, version string, force bool, out io.Writer) error
InstallComponent will install the specified component in the build tree.
func InstallToolchain ¶
InstallToolchain will install the toolchain for v4+ projects. 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 InstallToolchain3 ¶ added in v0.9.0
InstallToolchain3 will install the toolchain for v3 projects. 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.