#1 Add man pages
Merged 2 years ago by jcpunk. Opened 2 years ago by music.
rpms/ music/jsonnet man-pages  into  rawhide

file added
+145
@@ -0,0 +1,145 @@ 

+ .TH JSONNNET "1" "June 2021" "" "User Commands"

+ .SH NAME

+ jsonnet \- jsonnet commandline interpreter

+ .SH SYNOPSIS

+ .B jsonnet

+ .RI [ option \ ...]

+ .I filename

+ .SH OPTIONS

+ In all cases:

+ .RS +3n

+ .IP \(bu 2

+ .I filename

+ can be

+ .B \-

+ (stdin)

+ .IP \(bu 2

+ Multichar options are expanded e.g. \fB\-abc\fR becomes

+ .BR \-a\ \-b\ \-c .

+ .IP \(bu 2

+ The

+ .B \--

+ option suppresses option processing for subsequent arguments.

+ .IP \(bu 2

+ Note that since filenames and jsonnet programs can begin with

+ .BR - ,

+ it is advised to use

+ .B \-\-

+ if the argument is unknown, e.g. \fBjsonnet\ \-\-\ "$\fIFILENAME\fB"\fR.

+ .RE

+ .SS "AVAILABLE OPTIONS"

+ .TP

+ .B \-h\fR,\ \fB\-\-help

+ Print a usage message

+ .TP

+ .B \-e\fR,\ \fB\-\-exec

+ Treat

+ .I filename

+ as code

+ .TP

+ .B \-J\fR,\ \fB\-\-jpath \fIdir

+ Specify an additional library search directory (right-most wins)

+ .TP

+ .B \-o\fR,\ \fB\-\-output\-file \fIfile

+ Write to the output file rather than stdout

+ .TP

+ .B \-m\fR,\ \fB\-\-multi \fIdir

+ Write multiple files to the directory, list files on stdout

+ .TP

+ .B \-y\fR,\ \-\-yaml\-stream

+ Write output as a YAML stream of JSON documents

+ .TP

+ .B \-S\fR,\ \-\-string

+ Expect a string, manifest as plain text

+ .TP

+ .B \-s\fR,\ \-\-max\-stack\ \fIn

+ Number of allowed stack frames

+ .TP

+ .B \-t\fR,\ \-\-max\-trace\ \fIn

+ Max length of stack trace before cropping

+ .TP

+ .B \-\-gc\-min\-objects\ \fIn

+ Do not run garbage collector until this many

+ .TP

+ .B \-\-gc\-growth\-trigger\ \fIn

+ Run garbage collector after this amount of object growth

+ .TP

+ .B \-\-version

+ Print version

+ .SS "AVAILABLE OPTIONS FOR SPECIFYING VALUES OF \(oqEXTERNAL\(cq VARIABLES"

+ .P

+ Provide the value as a string:

+ .TP

+ .B \-V\fR,\ \fB-\-ext\-str\ \fIvar\fR[=\fIval\fR]

+ If

+ .I val

+ is omitted, get from environment var

+ .I var

+ .PD 0

+ .TP

+ .in +4x

+ .B \-\-ext\-str\-file\ \fIvar\fR=\fIfile

+ Read the string from the file

+ .in

+ .PD

+ .P

+ Provide the value as Jsonnet code:

+ .TP

+ .B \-\-ext\-code\ \fIvar\fR[=\fIcode\fR]

+ If

+ .I code

+ is omitted, get from environment var

+ .I var

+ .TP

+ .B \-\-ext\-code\-file\ \fIvar\fR=\fIfile

+ Read the code from the file

+ .SS "AVAILABLE OPTIONS FOR SPECIFYING VALUES OF \(oqTOP-LEVEL ARGUMENTS\(cq"

+ .P

+ Provide the value as a string:

+ .TP

+ .B \-V\fR,\ \fB-\-tla\-str\ \fIvar\fR[=\fIval\fR]

+ If

+ .I val

+ is omitted, get from environment var

+ .I var

+ .PD 0

+ .TP

+ .in +4x

+ .B \-\-tla\-str\-file\ \fIvar\fR=\fIfile

+ Read the string from the file

+ .in

+ .PD

+ .P

+ Provide the value as Jsonnet code:

+ .TP

+ .B \-\-tla\-code\ \fIvar\fR[=\fIcode\fR]

+ If

+ .I code

+ is omitted, get from environment var

+ .I var

+ .TP

+ .B \-\-tla\-code\-file\ \fIvar\fR=\fIfile

+ Read the code from the file

+ .SH ENVIRONMENT

+ .TP

+ .B JSONNET_PATH

+ is a colon (semicolon on Windows) separated list of directories added in

+ reverse order before the paths specified by

+ .B \-\-jpath

+ (i.e. left-most wins)

+ .IP

+ E.g.

+ .in +4n

+ .EX

+ .B JSONNET_PATH=a:b\ jsonnet\ \-J\ c\ \-J\ d

+ .EE

+ .in

+ is equivalent to:

+ .in +4n

+ .EX

+ .B JSONNET_PATH=d:c:a:b\ jsonnet

+ .B jsonnet\ \-J\ b\ \-J\ a\ \-J\ c\ \-J\ d

+ .EE

+ .in

+ .SH "SEE\ ALSO"

+ .BR jsonnetfmt (1)

file modified
+15 -2
@@ -2,8 +2,8 @@ 

  

  Name:           jsonnet

  Version:        0.17.0

- Release:        1%{?dist}

- Summary:        Diff JSON and JSON-like structures

+ Release:        2%{?dist}

+ Summary:        A data templating language based on JSON

  

  # The bundled MD5 library is RSA licenced

  License:        ASL 2.0 and RSA
@@ -11,6 +11,10 @@ 

  URL:            https://github.com/google/jsonnet

  Source0:        %{url}/archive/v%{version}/%{name}-%{version}.tar.gz

  

+ # Downstream man pages in groff_man(7) format

+ Source1:        jsonnet.1

+ Source2:        jsonnetfmt.1

+ 

  # Upstream wants to build single source wheels

  # these benefit from static linking,

  # but we want to link to libjsonnet here so we are sharing the lib
@@ -112,6 +116,9 @@ 

  # install python binding

  %{py3_install}

  

+ install -d '%{buildroot}%{_mandir}/man1'

+ install -t '%{buildroot}%{_mandir}/man1' -p -m 0644 '%{SOURCE1}' '%{SOURCE2}'

+ 

  

  %check

  %ctest
@@ -120,6 +127,8 @@ 

  %files

  %{_bindir}/jsonnet

  %{_bindir}/jsonnetfmt

+ %{_mandir}/man1/jsonnet.1*

+ %{_mandir}/man1/jsonnetfmt.1*

  

  %files libs

  %license LICENSE
@@ -147,5 +156,9 @@ 

  

  

  %changelog

+ * Fri Jun 25 2021 Benjamin A. Beasley <code@musicinmybrain.net> - 0.17.0-2

+ - Add downstream man pages

+ - Fix Summary

+ 

  * Thu Jun 17 2021 Pat Riehecky <riehecky@fnal.gov> - 0.17.0-1

  - Initial package.

file added
+90
@@ -0,0 +1,90 @@ 

+ .TH JSONNNET "1" "June 2021" "" "User Commands"

+ .SH NAME

+ jsonnetfmt \- jsonnet reformatter

+ .SH SYNOPSIS

+ .B jsonnetfmt

+ .RI [ option \ ...]

+ .RI [ filename ]

+ .SH OPTIONS

+ In all cases:

+ .RS +3n

+ .IP \(bu 2

+ .I filename

+ can be

+ .B \-

+ (stdin)

+ .IP \(bu 2

+ Multichar options are expanded e.g. \fB\-abc\fR becomes

+ .BR \-a\ \-b\ \-c .

+ .IP \(bu 2

+ The

+ .B \--

+ option suppresses option processing for subsequent arguments.

+ .IP \(bu 2

+ Note that since filenames and jsonnet programs can begin with

+ .BR - ,

+ it is advised to use

+ .B \-\-

+ if the argument is unknown, e.g. \fBjsonnet\ \-\-\ "$\fIFILENAME\fB"\fR.

+ .RE

+ .SS "AVAILABLE OPTIONS"

+ .TP

+ .B \-h\fR,\ \fB\-\-help

+ Print a usage message

+ .TP

+ .B \-e\fR,\ \fB\-\-exec

+ Treat

+ .I filename

+ as code

+ .TP

+ .B \-o\fR,\ \fB\-\-output\-file \fIfile

+ Write to the output file rather than stdout

+ .TP

+ .B \-i\fR,\ \fB\-\-in\-place

+ Update the Jsonnet file(s) in place

+ .TP

+ .B \-\-test

+ Exit with failure if reformatting changed the file(s)

+ .TP

+ .B \-n\fR,\ \-\-indent\ \fIn

+ Number of spaces to indent by (default

+ .BR 2 ,

+ .B 0

+ means no change)

+ .TP

+ .B \-\-string\-style\ \fR[\fBd\fR|\fBs\fR|\fBl\fR]

+ Enforce

+ .IR d ouble,

+ .IR s ingle

+ (default) quotes or

+ .RI \(oq l eave\(cq

+ .TP

+ .B \-\-comment\-style\ \fR[\fBh\fR|\fBs\fR|\fBl\fR]

+ .BI #\ ( h )\fR,

+ .BI //\ ( s )

+ (default), or \(oq\fIl\fReave\(cq

+ .TP

+ .BR \-\- [ no\- ] pretty\-field\-names

+ Use syntax sugar for fields and indexing (on by default)

+ .TP

+ .BR \-\- [ no\- ] pad\-arrays

+ .B [\ 1,\ 2,\ 3\ ]

+ instead of

+ .B [1,\ 2,\ 3]

+ .TP

+ .BR \-\- [ no\- ] pad\-objects

+ .B {\ x:\ 1,\ y:\ 2\ }

+ instead of

+ .B {x:\ 1,\ y:\ 2}

+ (on by default)

+ .TP

+ .BR \-\- [ no\- ] sort\-imports

+ Sorting of imports (on by default)

+ .TP

+ .B \-\-debug\-desugaring

+ Unparse the desugared AST without executing it

+ .TP

+ .B \-\-version

+ Print version

+ .SH "SEE\ ALSO"

+ .BR jsonnet (1)

Adds downstream man pages in groff_man(7) format.

(Also fixes the Summary, which was copy-pasted from python-jsondiff.)

Pull-Request has been merged by jcpunk

2 years ago