Documentation
¶
Index ¶
- Constants
- func Assemble(root, path string) (files map[string][]byte, foreign []string, err error)
- func Complete() bool
- func Generated(page []byte) bool
- func LinkChanges(was, now []byte) []string
- func Run(root, path string, out io.Writer) error
- func Write(path, service string, records []trace.Record) error
- type Branch
- type Doc
- type Flow
- type Index
- type Input
- type Link
- type Orphan
- type Output
Constants ¶
View Source
const Format = "flows/1"
Format is what this package writes under specrig: and the newest it reads.
View Source
const IndexFormat = "index/1"
IndexFormat is what Assemble writes under specrig: and the newest it reads.
Variables ¶
This section is empty.
Functions ¶
func Assemble ¶
Assemble builds the index at path and a page per input a flow reaches beside it, keeping the prose the index at path already has. Foreign are the files at a record's path it took for somebody else's.
func Complete ¶
func Complete() bool
Complete says whether the suite ran whole: a narrowed run saw part of the service, and its document would lose the rest.
func LinkChanges ¶
LinkChanges says, between two versions of an index, which links between services were lost and which appeared: the reason a page changed.
Types ¶
type Index ¶
type Index struct {
Specrig string `yaml:"specrig"`
Flows []Flow `yaml:"flows"`
Links []Link `yaml:"links,omitempty"`
Untested []string `yaml:"untested,omitempty"`
Outside []string `yaml:"outside,omitempty"`
System *surface.Report `yaml:"system,omitempty"`
Orphaned []Orphan `yaml:"orphaned,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.