Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,15 @@ follow semantic versioning; release dates are ISO 8601.

### Documentation

- **The PowerShell commands run as written.** Two pages handed Windows readers a
command that fails. PowerShell splits a `-D` flag whose property name contains a dot,
passing the native command `-Dexec` and `.mainClass=…` as separate arguments, and
Maven then rejects the fragment with `Unknown lifecycle phase ".mainClass=…"`; a flag
with no dot before the `=` survives, which is what makes it easy to miss. The
examples README compounded it by claiming the bash form works unchanged on
PowerShell — the block above it ends a line with `\`, a continuation PowerShell does
not have — while pointing at backslash paths, which were never the problem. Both
pages now carry the command that was run on PowerShell to check it.
- **The authoring cheatsheet stops describing `lineSpacing` as a multiple.** Its
address-block recipe passed `1.3` and explained it as overriding a default of `1.0` —
the reading a CSS `line-height` invites, and the one the number itself suggests.
Expand Down
7 changes: 6 additions & 1 deletion docs/operations/benchmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,8 +293,13 @@ reference, with the IDE closed:

**Windows (PowerShell):**

A `-D` flag whose property name contains a dot has to be quoted here — unquoted,
PowerShell hands the native command `-Dmdep` and `.outputFile=…` as two arguments and
Maven rejects the second as a lifecycle phase. That is why the `java` lines below quote
theirs too.

```powershell
.\mvnw.cmd -B -ntp -f benchmarks\pom.xml test-compile dependency:build-classpath -DincludeScope=test -Dmdep.outputFile=target/benchmark.classpath
.\mvnw.cmd -B -ntp -f benchmarks\pom.xml test-compile dependency:build-classpath -DincludeScope=test "-Dmdep.outputFile=target/benchmark.classpath"
$cp = 'benchmarks\target\test-classes;benchmarks\target\classes;' + (Get-Content benchmarks\target\benchmark.classpath -Raw).Trim()
1..5 | ForEach-Object { & java "-Dgraphcompose.benchmark.profile=full" -cp "$cp" com.demcha.compose.CurrentSpeedBenchmark }
$runs = Get-ChildItem target\benchmarks\current-speed\run-*.json | Sort-Object Name | Select-Object -Last 5 | ForEach-Object { $_.FullName }
Expand Down
15 changes: 13 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,19 @@ Source path into a class name: drop `src/main/java/` and `.java`, then swap `/`
So `src/main/java/com/demcha/examples/flagships/ModuleFirstFileExample.java` becomes
`com.demcha.examples.flagships.ModuleFirstFileExample`.

Generated PDFs land in `examples/target/generated-pdfs/`. The same `mvnw.cmd` form
works on Windows PowerShell with backslash paths.
Generated PDFs land in `examples/target/generated-pdfs/`.

On Windows PowerShell the wrapper is `.\mvnw.cmd` and the command needs two changes,
neither of them cosmetic. The trailing `\` above is a shell continuation PowerShell does
not have, so the command must be one line. And `-Dexec.mainClass=…` has to be quoted:
unquoted, PowerShell splits it and Maven receives `.mainClass=…` as a separate argument,
failing with `Unknown lifecycle phase ".mainClass=…"`.

```powershell
.\mvnw.cmd -f examples/pom.xml exec:java "-Dexec.mainClass=com.demcha.examples.flagships.ModuleFirstFileExample"
```

Forward slashes are fine in the `-f` path; nothing needs converting to backslashes.

To regenerate the **whole catalogue** — roughly a hundred documents, and the output
directory is emptied first — run the batch entry point. You do not need it to read one
Expand Down