Skip to content

fix(man): strip leading commas from BNF grammar blocks in generated MDX #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Kaysahni wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(man): strip leading commas from BNF grammar blocks in generated MDX #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions man/flox-containerize.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,12 +104,12 @@ container build time. See details below.
```text
ContainerizeConfig ::= {
user = null | <STRING>
, exposed-ports = null | [<STRING>, ...]
, cmd = null | [<STRING>, ...]
, volumes = null | [<STRING>, ...]
, working-dir = null | <STRING>
, labels = null | Map[STRING, STRING]
, stop-signal = null | <STRING>
exposed-ports = null | [<STRING>, ...]
cmd = null | [<STRING>, ...]
volumes = null | [<STRING>, ...]
working-dir = null | <STRING>
labels = null | Map[STRING, STRING]
stop-signal = null | <STRING>
}
```

Expand Down
54 changes: 27 additions & 27 deletions man/manifest.toml.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,11 +154,11 @@ The full list of catalog descriptor options is:
```text
Descriptor ::= {
pkg-group = null | <STRING>
, version = null | <STRING>
, systems = null | [<STRING>, ...]
, pkg-path = <STRING>
, priority = null | <INT>
, outputs = null | "all" | [<STRING>, ...]
version = null | <STRING>
systems = null | [<STRING>, ...]
pkg-path = <STRING>
priority = null | <INT>
outputs = null | "all" | [<STRING>, ...]
}
```

Expand Down Expand Up @@ -261,9 +261,9 @@ The full list of flake descriptor options is:
```text
Descriptor ::= {
flake = <STRING>
, systems = null | [<STRING>, ...]
, priority = null | <INT>
, outputs = null | "all" | [<STRING>, ...]
systems = null | [<STRING>, ...]
priority = null | <INT>
outputs = null | "all" | [<STRING>, ...]
}
```

Expand Down Expand Up @@ -294,8 +294,8 @@ The full list of store path descriptor options is:
```text
Descriptor ::= {
store-path = STRING
, systems = null | [<STRING>, ...]
, priority = null | <INT>
systems = null | [<STRING>, ...]
priority = null | <INT>
}
```

Expand Down Expand Up @@ -470,10 +470,10 @@ The full set of options for an individual service descriptor is:
```text
ServiceDescriptor ::= {
command = STRING
, vars = null | Map[STRING, STRING]
, is-daemon = null | BOOL
, shutdown = null | Shutdown
, systems = null | [<STRING>, ...]
vars = null | Map[STRING, STRING]
is-daemon = null | BOOL
shutdown = null | Shutdown
systems = null | [<STRING>, ...]
}

Shutdown ::= {
Expand Down Expand Up @@ -560,18 +560,18 @@ IncludeDescriptor ::= LocalIncludeDescriptor

LocalIncludeDescriptor ::= {
dir = STRING
, name = null | STRING
name = null | STRING
}

FloxHubIncludeDescriptor ::= {
remote = STRING
, name = null | STRING
name = null | STRING
}

# Deprecated, will be removed in a future release
RemoteIncludeDescriptor ::= {
remote = STRING
, name = null | STRING
name = null | STRING
}
```

Expand Down Expand Up @@ -691,10 +691,10 @@ The full set of options is shown below:
```text
BuildDescriptor ::= {
command = STRING
, sandbox = null | ("off" | "pure")
, version = null | STRING | VersionFile | VersionCommand
, description = null | STRING
, runtime-packages = null | [<STRING>, ...]
sandbox = null | ("off" | "pure")
version = null | STRING | VersionFile | VersionCommand
description = null | STRING
runtime-packages = null | [<STRING>, ...]
}

VersionFile ::= {
Expand Down Expand Up @@ -748,10 +748,10 @@ The full set of options are listed below:
```text
Options ::= {
systems = null | [<STRING>, ...]
, activate = null | Activate
, allow = null | Allows
, semver = null | Semver
, cuda-detection = null | <BOOL>
activate = null | Activate
allow = null | Allows
semver = null | Semver
cuda-detection = null | <BOOL>
}

Activate ::= {
Expand All @@ -760,8 +760,8 @@ Activate ::= {

Allows ::= {
unfree = null | <BOOL>
, broken = null | <BOOL>
, licenses = null | [<STRING>, ...]
broken = null | <BOOL>
licenses = null | [<STRING>, ...]
}

Semver ::= {
Expand Down
3 changes: 2 additions & 1 deletion scripts/sync-man-pages.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ sync_man_pages() {
# Rewrite cross-references: (./flox-push.md) -> (/man/flox-push)
sed -E -e 's|\(\./([A-Za-z0-9._-]+)\.md\)|(/man/\1)|g' \
-e 's|\[`([A-Za-z0-9._-]+)\([0-9]\)`\]|[`\1`]|g' \
-e 's|^``` ([A-Za-z0-9_+-]+)$|```\1|' |
-e 's|^``` ([A-Za-z0-9_+-]+)$|```\1|' \
-e 's/^, / /' |
# Drop pandoc's '<!-- -->' block separators (MDX cannot parse HTML
# comments) along with the blank line that follows each one
awk '{
Expand Down