Skip to content

Commit 719a086

Browse files
committed
docs(core): add docs for maxFilename
1 parent 2587b48 commit 719a086

File tree

1 file changed

+58
-7
lines changed

1 file changed

+58
-7
lines changed

docs/runner/intro/configure.md

+58-7
Original file line numberDiff line numberDiff line change
@@ -617,18 +617,24 @@ marathon {
617617

618618
### Output configuration
619619

620-
#### Max file path
620+
#### Max file name length
621621

622-
By default, the max file path for any output file is capped at 255 characters due to limitations of some OSs. This is the reason why some
623-
test runs have lots of "File path length cannot exceed" messages in the log. Since there is currently no API to programmatically
624-
establish this limit, it's the user's responsibility to set a larger value if the OS supports this and the user desires it.
622+
By default, the max file name length for any output file is capped at 255 characters due to limitations of most file systems. This is the
623+
reason why some test runs have lots of "File name length cannot exceed" messages in the log. Since there is currently no API to
624+
programmatically establish this limit, it's the user's responsibility to set a larger value if the OS supports this and the user desires it.
625+
626+
:::info
627+
628+
Value 0 is equivalent to unlimited file path length
629+
630+
:::
625631

626632
<Tabs>
627633
<TabItem value="YAML" label="Marathonfile">
628634

629635
```yaml
630636
outputConfiguration:
631-
maxPath: 1024
637+
maxFilename: 1024
632638
```
633639

634640
</TabItem>
@@ -637,7 +643,7 @@ outputConfiguration:
637643
```kotlin
638644
marathon {
639645
outputConfiguration {
640-
maxPath = 1024
646+
maxFilename = 1024
641647
}
642648
}
643649
```
@@ -648,12 +654,57 @@ marathon {
648654
```groovy
649655
marathon {
650656
outputConfiguration {
651-
maxPath = 1024
657+
maxFilename = 1024
652658
}
653659
}
654660
```
655661

656662
</TabItem>
657663
</Tabs>
658664

665+
#### Max file path length
666+
667+
By default, the max file path length for any output file is unlimited which is the default for most file systems. If the user has some
668+
specific constraints then it's possible to limit the max file path length:
669+
670+
:::info
671+
672+
Value 0 is equivalent to unlimited file path length
673+
674+
:::
675+
676+
<Tabs>
677+
<TabItem value="YAML" label="Marathonfile">
678+
679+
```yaml
680+
outputConfiguration:
681+
maxPath: 32767
682+
```
683+
684+
</TabItem>
685+
<TabItem value="kts" label="Kotlin DSL">
686+
687+
```kotlin
688+
marathon {
689+
outputConfiguration {
690+
maxPath = 32767
691+
}
692+
}
693+
```
694+
695+
</TabItem>
696+
<TabItem value="groovy" label="Groovy DSL">
697+
698+
```groovy
699+
marathon {
700+
outputConfiguration {
701+
maxPath = 32767
702+
}
703+
}
704+
```
705+
706+
</TabItem>
707+
</Tabs>
708+
709+
659710
[1]: https://github.com/MarathonLabs/marathon/blob/develop/configuration/src/main/kotlin/com/malinskiy/marathon/config/serialization/ConfigurationFactory.kt

0 commit comments

Comments
 (0)