diff options
author | Luke Shumaker <lukeshu@lukeshu.com> | 2018-10-23 13:31:53 -0400 |
---|---|---|
committer | Luke Shumaker <lukeshu@lukeshu.com> | 2018-10-23 19:17:42 -0400 |
commit | 392cc1262df7203a6c8b4f6b692cd69950ccc598 (patch) | |
tree | aaf6eb2bb8068bd40a32d17dc62551bbef3a93d3 /cmd.go | |
parent | aab6e690da587d54301225705ea5ee97512a49e0 (diff) |
Add godoc comments
Diffstat (limited to 'cmd.go')
-rw-r--r-- | cmd.go | 16 |
1 files changed, 15 insertions, 1 deletions
@@ -1,4 +1,4 @@ -// Copyright (C) 2017 Luke Shumaker <lukeshu@lukeshu.com> +// Copyright (C) 2017-2018 Luke Shumaker <lukeshu@lukeshu.com> // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU Affero General Public License as published by @@ -13,6 +13,19 @@ // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see <https://www.gnu.org/licenses/>. +// Package libfastimport implements reading and writing of git +// fast-import streams. +// +// The documentation here focuses on use of the package itself; it +// generally assumes a working understanding of the format. +// Documentation on the format itself can be found in the +// git-fast-import(1) man-page. +// +// A program can write commands to a backend by wrapping the +// appropriate io.Writer with a Backend object. +// +// A program can read commands from a frontend by wrapping the +// appropriate io.Reader with a Frontend object. package libfastimport type fiReader interface { @@ -34,6 +47,7 @@ const ( cmdClassComment cmdClass = cmdClassCommand | cmdClassCommit ) +// Cmd is a command that may be found in a fast-import stream. type Cmd interface { fiCmdRead(fiReader) (Cmd, error) fiCmdWrite(fiWriter) error |