Skip to content

Commit 07489c6

Browse files
author
Marek Suchánek
committed
Document how newdoc treats overwriting existing files
1 parent 2b72aff commit 07489c6

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,14 @@ Note: The configuration files for a container image are still usable in the repo
175175
2. Rewrite the placeholders in the generated file with your docs.
176176
177177
178+
## Overwriting existing files
179+
180+
When generating a new file, `newdoc` warns you if a file by that name already exists in this directory. It prompts you to choose an action:
181+
182+
* Overwrite the existing file with the new file.
183+
* Preserve the existing file and cancel the newly generated file.
184+
185+
178186
## Validating a file for Red Hat requirements
179187
180188
You can use the `--validate` (`-l`) option to check an existing file for Red Hat publishing requirements. For example:

0 commit comments

Comments
 (0)