From 392cc1262df7203a6c8b4f6b692cd69950ccc598 Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Tue, 23 Oct 2018 13:31:53 -0400 Subject: Add godoc comments --- cmd.go | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'cmd.go') diff --git a/cmd.go b/cmd.go index 6d9e055..1665081 100644 --- a/cmd.go +++ b/cmd.go @@ -1,4 +1,4 @@ -// Copyright (C) 2017 Luke Shumaker +// Copyright (C) 2017-2018 Luke Shumaker // // 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 . +// 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 -- cgit v1.2.3