From 3e1fab4f16d9a0f0eac83b13079fcf64ed40a070 Mon Sep 17 00:00:00 2001 From: Jeff Dairiki Date: Sat, 11 Mar 2023 12:47:16 -0800 Subject: [PATCH] docs(cls): updates for lektor/lektor#1120 Note that --output-path is (now) interpreted relative to the current working directory. --- content/docs/cli/build/contents.lr | 4 +++- content/docs/cli/clean/contents.lr | 4 +++- content/docs/cli/deploy/contents.lr | 4 +++- content/docs/cli/server/contents.lr | 6 +++++- 4 files changed, 14 insertions(+), 4 deletions(-) diff --git a/content/docs/cli/build/contents.lr b/content/docs/cli/build/contents.lr index 4c203d0b..21c6b981 100644 --- a/content/docs/cli/build/contents.lr +++ b/content/docs/cli/build/contents.lr @@ -30,6 +30,8 @@ used by external scripts to only deploy on successful build for instance. ## Options - `-O, --output-path PATH`: The output path. + This overrides any `output_path` setting in the [project file :ref](http://localhost:5000/docs/project/file/#project). + A relative path is interpreted relative to the *current working directory*. - `--watch`: If this is enabled the build process goes into an automatic loop where it watches the file system for changes and rebuilds. - `--prune / --no-prune`: Controls if old artifacts should be pruned. @@ -42,4 +44,4 @@ used by external scripts to only deploy on successful build for instance. used by plugins to customize the build process. More information can be found in the documentation of affected plugins. - `--profile`: Enable build profiler. -- `--help`: print this help page. \ No newline at end of file +- `--help`: print this help page. diff --git a/content/docs/cli/clean/contents.lr b/content/docs/cli/clean/contents.lr index 3bd6767a..3b773ed5 100644 --- a/content/docs/cli/clean/contents.lr +++ b/content/docs/cli/clean/contents.lr @@ -18,6 +18,8 @@ in the Lektor cache is used. ## Options - `-O, --output-path PATH`: The output path. + This overrides any `output_path` setting in the [project file :ref](http://localhost:5000/docs/project/file/#project). + A relative path is interpreted relative to the *current working directory*. - `-v, --verbose`: Increases the verbosity of the logging. - `--yes`: Confirms the cleaning. -- `--help`: print this help page. \ No newline at end of file +- `--help`: print this help page. diff --git a/content/docs/cli/deploy/contents.lr b/content/docs/cli/deploy/contents.lr index 445a6ae1..3a4a19bd 100644 --- a/content/docs/cli/deploy/contents.lr +++ b/content/docs/cli/deploy/contents.lr @@ -27,6 +27,8 @@ For more information see the deployment chapter in the documentation. ## Options - `-O, --output-path PATH`: The output path. + This overrides any `output_path` setting in the [project file :ref](http://localhost:5000/docs/project/file/#project). + A relative path is interpreted relative to the *current working directory*. - `--username TEXT`: An optional username to override the URL. - `--password TEXT`: An optional password to override the URL or the default prompt. @@ -34,4 +36,4 @@ For more information see the deployment chapter in the documentation. authentication of the deployment. - `--key TEXT`: The contents of a key file directly a string that should be used for authentication of the deployment. -- `--help`: print this help page. \ No newline at end of file +- `--help`: print this help page. diff --git a/content/docs/cli/server/contents.lr b/content/docs/cli/server/contents.lr index 6876a9b3..d2fdab2b 100644 --- a/content/docs/cli/server/contents.lr +++ b/content/docs/cli/server/contents.lr @@ -25,8 +25,12 @@ HTTP server. - `-p, --port INTEGER`: The port to bind to. - `-O, --output-path PATH`: The dev server will build into the same folder as the build command by default. +- `-O, --output-path PATH`: The output path. + Note that, by default, the dev server will build into the same folder as the build command. + This overrides any `output_path` setting in the [project file :ref](http://localhost:5000/docs/project/file/#project). + A relative path is interpreted relative to the *current working directory*. - `-v, --verbose`: Increases the verbosity of the logging. - `-f, --build-flag TEXT`: Defines an arbitrary build flag. These can be used by plugins to customize the build process. More information can be found in the documentation of affected plugins. -- `--help`: print this help page. \ No newline at end of file +- `--help`: print this help page.