Skip to content

Commit d94d7fb

Browse files
committed
added specs
1 parent c9345c1 commit d94d7fb

File tree

1 file changed

+76
-0
lines changed

1 file changed

+76
-0
lines changed

doc/specs/stdlib_system.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -456,6 +456,82 @@ The function returns a `logical` value:
456456

457457
---
458458

459+
## `make_directory` - Creates an empty directory
460+
461+
### Status
462+
463+
Experimental
464+
465+
### Description
466+
467+
It creates an empty directory.
468+
It is designed to work across multiple platforms. On Windows, paths with both forward `/` and backward `\` slashes are accepted.
469+
470+
### Syntax
471+
472+
`call [[stdlib_system(module):make_directory(subroutine)]] (path, mode, err)`
473+
474+
### Class
475+
476+
Subroutine
477+
478+
### Arguments
479+
480+
`path`: Shall be a character string containing the path of the directory to create. It is an `intent(in)` argument.
481+
482+
`mode`: Shall be a scalar integer indicating the permission bits required (Not applicable to Windows). It is an `optional, intent(in)` argument.
483+
484+
`err`: Shall be of type `state_type`, for error handling. It is an `optional, intent(out)` argument.
485+
486+
### Return values
487+
488+
The `err` is set accordingly.
489+
490+
### Example
491+
492+
```fortran
493+
{!example/system/example_make_directory.f90!}
494+
```
495+
496+
---
497+
498+
## `remove_directory` - Removes an empty directory
499+
500+
### Status
501+
502+
Experimental
503+
504+
### Description
505+
506+
It deletes an empty directory.
507+
It is designed to work across multiple platforms. On Windows, paths with both forward `/` and backward `\` slashes are accepted.
508+
509+
### Syntax
510+
511+
`call [[stdlib_system(module):remove_directory(subroutine)]] (path, err)`
512+
513+
### Class
514+
515+
Subroutine
516+
517+
### Arguments
518+
519+
`path`: Shall be a character string containing the path of the directory to create. It is an `intent(in)` argument.
520+
521+
`err`: Shall be of type `state_type`, for error handling. It is an `intent(out)` argument.
522+
523+
### Return values
524+
525+
The `err` is set accordingly.
526+
527+
### Example
528+
529+
```fortran
530+
{!example/system/example_remove_directory.f90!}
531+
```
532+
533+
---
534+
459535
## `null_device` - Return the null device file path
460536

461537
### Status

0 commit comments

Comments
 (0)