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_comment.go | |
| parent | aab6e690da587d54301225705ea5ee97512a49e0 (diff) | |
Add godoc comments
Diffstat (limited to 'cmd_comment.go')
| -rw-r--r-- | cmd_comment.go | 16 |
1 files changed, 15 insertions, 1 deletions
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 <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 @@ -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 (":<idnum>") 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 (":<idnum>") or by a full +// 40-byte SHA-1. type CmdLs struct { DataRef string // optional if inside of a commit Path textproto.Path |