Skip to content

Commit a320860

Browse files
committed
refactor: no more system properties
1 parent b233b19 commit a320860

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

config-specs/paper/paper-global.yml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,17 @@ spam-limiter:
358358
spark:
359359
enabled:
360360
default: "true"
361-
description: Whether the spark profiler should be enabled.
361+
description: Whether the bundled spark profiler should be enabled.
362+
enable-immediately:
363+
default: "false"
364+
description: >-
365+
Whether the bundled spark profiler should be enabled as soon as possible. This can be useful for profiling the server during startup.
366+
By default, spark is enabled once the server has finished starting up (when the **Done (X.XXXs)! For help, type "help"** message is sent in the console).
367+
prefer-spark-plugin:
368+
default: "false"
369+
description: >-
370+
Whether the bundled spark profiler should be disabled in favor of a standalone plugin.
371+
If the spark plugin is not found, the bundled version will be loaded regardless of the setting, unless it is [explicitly disabled](#spark_enabled).
362372
timings:
363373
enabled:
364374
default: "false"

docs/paper/admin/how-to/profiling.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ or learn to analyze reports yourself, check out spark's documentation [here](htt
3737
:::tip
3838

3939
If you want to use a version of spark newer than the bundled one, simply place a standalone spark plugin JAR
40-
into the `plugins` directory and set the [`paper.preferSparkPlugin`](../reference/system-properties.md#paperprefersparkplugin)
41-
property.
40+
into the `plugins` directory and enable the [`spark.prefer-spark-plugin`](../reference/configuration/global-configuration.mdx#spark_prefer_spark_plugin)
41+
global configuration option.
4242

4343
:::
4444

docs/paper/admin/reference/system-properties.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -215,13 +215,3 @@ It also remaps plugin CB calls to remove the version information.
215215

216216
- **default**: `false`
217217
- **description**: Disables plugin remapping introduced in 1.20.5 and everything involving automatic plugin conversion by commodore. For more information see the [userdev](../../dev/getting-started/userdev.mdx#1205-and-beyond) documentation and the official [announcement](https://discord.com/channels/289587909051416579/976631292747735080/1232740079097876570).
218-
219-
#### paper.enableSparkImmediately
220-
221-
- **default**: `false`
222-
- **description**: Enables the spark profiler as soon as possible when set to true. Otherwise, it is enabled once the server has finished starting up (when the `Done (X.XXXs)! For help, type "help"` message is sent in the console).
223-
224-
#### paper.preferSparkPlugin
225-
226-
- **default**: `false`
227-
- **description**: Disables the bundled spark profiler in favor of a standalone plugin when set to true. If the spark plugin is not found, the bundled version will be loaded regardless, unless it is disabled [in the configuration](./configuration/global-configuration.mdx#spark_enabled).

0 commit comments

Comments
 (0)