Documentation
¶
Overview ¶
Package compdb provides the structs for generate compilation database as specified by https://clang.llvm.org/docs/JSONCompilationDatabase.html
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Command ¶
type Command struct {
// The working directory of the compilation. All paths specified in the
// command or file fields must be either absolute or relative to this
// directory.
Directory string `json:"directory,omitempty"`
// The main translation unit source processed by this compilation step.
// This is used by tools as the key into the compilation database.
// There can be multiple command objects for the same file, for example
// if the same source file is compiled with different configurations.
File string `json:"file,omitempty"`
// The compile command argv as list of strings. This should run the
// compilation step for the translation unit file. arguments[0] should
// be the executable name, such as clang++. Arguments should not be
// escaped, but ready to pass to execvp().
Arguments []string `json:"arguments,omitempty"`
// The compile command as a single shell-escaped string. Arguments may
// be shell quoted and escaped following platform conventions, with ‘"’
// and ‘\’ being the only special characters. Shell expansion is not
// supported.
Command string `json:"command,omitempty"`
// The name of the output created by this compilation step. This field
// is optional. It can be used to distinguish different processing
// modes of the same input file.
Output string `json:"output,omitempty"`
}
Command is a compilation database entry.
Click to show internal directories.
Click to hide internal directories.