shinyoukai/kosuzu
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update inline documentation

Browse Source 
Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja>

git-svn-id: file:///srv/svn/repo/kosuzu/trunk@68 eb64cd80-c68d-6f47-b6a3-0ada418499da
This commit is contained in:
yakumo.izuru
2024-08-21 02:15:27 +00:00
parent c6c66adf74
commit eef10b21e7
5 changed files with 28 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile
View File

@@ -10,7 +10,7 @@ LD=cc
all: all:
@dune build @dune build
deps: deps:
@opam install dune ocurl cmdliner=1.0.4 msgpck @opam install dune ocurl cmdliner msgpck
cli: cli:
@dune build cli/txt.exe @dune build cli/txt.exe
clean: clean:
@@ -19,7 +19,7 @@ dist:
@dune build @dune build
@cp _build/default/cli/txt.exe txt.exe @cp _build/default/cli/txt.exe txt.exe
@strip txt.exe @strip txt.exe
@tar czvf "kosuzu-${OS}-${MACHINE}-${DATE}-${COMMIT}" txt.exe readme.txt @tar czvf "logarion-${OS}-${MACHINE}-${DATE}-${COMMIT}" txt.exe readme.txt
@rm txt.exe @rm txt.exe
install: install:
@dune install --prefix ${PREFIX} @dune install --prefix ${PREFIX}

4
cli/edit.ml
View File

@@ -14,7 +14,9 @@ let cmd =
let man = [ let man = [
`S Manpage.s_description; `S Manpage.s_description;
`P "Launches EDITOR (nano if environment variable is unset) with text path as parameter."; `P "Launches EDITOR (nano if environment variable is unset) with text path as parameter.";
`P "If -R is used, the ID search space includes texts found in subdirectories, too." ] `P "If -R is used, the ID search space includes texts found in subdirectories, too.";
`S Manpage.s_environment;
`P "EDITOR - Default editor name" ]
in in
let info = Cmd.info "edit" ~version:"%%VERSION%%" ~doc ~man in let info = Cmd.info "edit" ~version:"%%VERSION%%" ~doc ~man in
Cmd.v info edit_t Cmd.v info edit_t

5
cli/new.ml
View File

@@ -23,7 +23,10 @@ let cmd =
let doc = "Create a new article" in let doc = "Create a new article" in
let man = [ let man = [
`S Manpage.s_description; `S Manpage.s_description;
`P "Create a new article, with title 'Draft' when none provided" ] `P "Create a new article, with title 'Draft' when none provided";
`S Manpage.s_environment;
`P "USER - The login name of the user, used if the Authors field is blank";
`P "EDITOR - Default editor name" ]
in in
let info = Cmd.info "new" ~version:"%%VERSION%%" ~doc ~man in let info = Cmd.info "new" ~version:"%%VERSION%%" ~doc ~man in
Cmd.v info new_t Cmd.v info new_t

33
cli/txt.ml
View File

@@ -1,19 +1,19 @@
open Cmdliner open Cmdliner
let subs = [ let subs = [
Authors.cmd; (* Done *) Authors.cmd;
Convert.cmd; (* Done *) Convert.cmd;
Edit.cmd; (* Done *) Edit.cmd;
File.cmd; (* Done *) File.cmd;
Index.cmd; (* Done *) Index.cmd;
Last.cmd; (* Done *) Last.cmd;
Listing.cmd; (* Done *) Listing.cmd;
New.cmd; (* Done *) New.cmd;
Peers.cmd; (* Done *) Peers.cmd;
Pull.cmd; (* Done *) Pull.cmd;
Recent.cmd; (* Done *) Recent.cmd;
Topics.cmd; (* Done *) Topics.cmd;
Unfile.cmd; (* Done *) Unfile.cmd;
] ]
let default_cmd = Term.(ret (const (`Help (`Pager, None)))) let default_cmd = Term.(ret (const (`Help (`Pager, None))))
@@ -21,8 +21,11 @@ let default_cmd = Term.(ret (const (`Help (`Pager, None))))
let txt = let txt =
let doc = "Discover, collect and exchange texts" in let doc = "Discover, collect and exchange texts" in
let man = [ let man = [
`S "CONTACT"; `S Manpage.s_authors;
`P "<mailto:logarion-dev@chaotic.ninja>"; ] `P "orbifx <mailto:fox@orbitalfox.eu>";
`P "Izuru Yakumo <mailto:yakumo.izuru@chaotic.ninja>";
`S Manpage.s_bugs;
`P "Please report them at <mailto:logarion-dev@chaotic.ninja>"; ]
in in
Cmd.group (Cmd.info "txt" ~version:"%%VERSION%%" ~doc ~man) ~default:default_cmd subs Cmd.group (Cmd.info "txt" ~version:"%%VERSION%%" ~doc ~man) ~default:default_cmd subs

2
logarion.opam
View File

@@ -1,6 +1,6 @@
# This file is generated by dune, edit dune-project instead # This file is generated by dune, edit dune-project instead
opam-version: "2.0" opam-version: "2.0"
version: "1.4.0" version: "1.4.1"
synopsis: "Texts archival and exchange" synopsis: "Texts archival and exchange"
maintainer: ["Izuru Yakumo <yakumo.izuru@chaotic.ninja>"] maintainer: ["Izuru Yakumo <yakumo.izuru@chaotic.ninja>"]
authors: ["orbifx <fox@orbitalfox.eu>"] authors: ["orbifx <fox@orbitalfox.eu>"]