From 970e8578c5326ad236304ecbaba05920c80448bd Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Tue, 23 Oct 2018 12:34:16 -0400 Subject: License under the AGPL --- cmd_comment.go | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'cmd_comment.go') diff --git a/cmd_comment.go b/cmd_comment.go index d2aaccc..14832da 100644 --- a/cmd_comment.go +++ b/cmd_comment.go @@ -1,3 +1,18 @@ +// Copyright (C) 2017 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 +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + package libfastimport import ( -- cgit v1.2.3 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_comment.go | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'cmd_comment.go') diff --git a/cmd_comment.go b/cmd_comment.go index 14832da..c640fef 100644 --- a/cmd_comment.go +++ b/cmd_comment.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 @@ -25,6 +25,7 @@ import ( // comment ///////////////////////////////////////////////////////////////////// +// CmdComment is a comment line; not a real command. type CmdComment struct { Comment string } @@ -44,6 +45,9 @@ func (CmdComment) fiCmdRead(fir fiReader) (cmd Cmd, err error) { // get-mark //////////////////////////////////////////////////////////////////// +// CmdGetMark requests that the Backend to report back (over the +// auxiliary cat-blob stream) with the SHA-1 corresponding to the +// given Mark. type CmdGetMark struct { Mark int } @@ -68,6 +72,10 @@ func (CmdGetMark) fiCmdRead(fir fiReader) (cmd Cmd, err error) { // cat-blob //////////////////////////////////////////////////////////////////// +// CmdCatBlob requests that the Backend to report back (over the +// auxiliary cat-blob stream) with the SHA-1 and content of the +// requested blob. The blob can be specified either by a mark +// reference (":") or by a full 40-byte SHA-1. type CmdCatBlob struct { DataRef string } @@ -87,6 +95,12 @@ func (CmdCatBlob) fiCmdRead(fir fiReader) (cmd Cmd, err error) { // ls ////////////////////////////////////////////////////////////////////////// +// CmdLs requests that the Backend to report back (over the auxiliary +// cat-blob stream) with information about the object at a path in the +// specified commit. If inside of a commit, specifying the commit is +// optional, and the ongoing commit is used. The commit can be +// specified either by a mark reference (":") or by a full +// 40-byte SHA-1. type CmdLs struct { DataRef string // optional if inside of a commit Path textproto.Path -- cgit v1.2.3