Skip to content

Commit f6829c8

Browse files
committed
add docs
1 parent 85b522b commit f6829c8

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

doc/specs/stdlib_system.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -572,6 +572,44 @@ Subroutine
572572

573573
---
574574

575+
## `make_directory_all` - Creates an empty directory with all its parent directories
576+
577+
### Status
578+
579+
Experimental
580+
581+
### Description
582+
583+
It creates an empty directory with default permissions.
584+
It also creates all the parent directories required in doing so.
585+
It is designed to work across multiple platforms. On Windows, paths with both forward `/` and backward `\` slashes are accepted.
586+
587+
### Syntax
588+
589+
`call [[stdlib_system(module):make_directory_all(subroutine)]] (path [,err])`
590+
591+
### Class
592+
593+
Subroutine
594+
595+
### Arguments
596+
597+
`path`: Shall be a character string containing the path of the directory to create. It is an `intent(in)` argument.
598+
599+
`err`(optional): Shall be of type `state_type`, for error handling. It is an `optional, intent(out)` argument.
600+
601+
### Return values
602+
603+
`err` is an optional state return flag. On error if not requested, a `FS_ERROR` will trigger an error stop.
604+
605+
### Example
606+
607+
```fortran
608+
{!example/system/example_make_directory.f90!}
609+
```
610+
611+
---
612+
575613
## `remove_directory` - Removes an empty directory
576614

577615
### Status

0 commit comments

Comments
 (0)