]> Kevux Git Server - fll/commitdiff
Cleanup: Use present tense.
authorKevin Day <thekevinday@gmail.com>
Sat, 1 Jan 2022 02:56:10 +0000 (20:56 -0600)
committerKevin Day <thekevinday@gmail.com>
Sat, 1 Jan 2022 02:56:10 +0000 (20:56 -0600)
Using past tense is a habit because everything being referred to is generally in the past.
The documentation and comments really should present tense despite this.
There is a lot of code that really needs this done but is not done in this comment.
I just happened to see these and decided to immediately fix them.

level_0/f_account/c/account.h
level_0/f_directory/c/directory.h
level_0/f_file/c/file.h
level_0/f_signal/c/signal.h
level_1/fl_directory/c/directory.h
level_1/fl_directory/c/private-directory.h

index 8c53b6d4297d83a88f21c19a9fc85ee6cf52ac13..b3b8bb0d8efcbddcddfd73a444f7f0ef64c4df7b 100644 (file)
@@ -46,7 +46,7 @@ extern "C" {
  *   F_none on success.
  *
  *   F_buffer_too_small (with error bit) if the buffer is too small to store the account data.
- *   F_file_descriptor_max (with error bit) if max file descriptors was reached.
+ *   F_file_descriptor_max (with error bit) if max file descriptors is reached.
  *   F_file_open_max (with error bit) too many open files.
  *   F_input_output (with error bit) if an I/O error occurred.
  *   F_interrupt (with error bit) when program received an interrupt signal, halting operation.
@@ -73,7 +73,7 @@ extern "C" {
  *   F_none on success.
  *
  *   F_buffer_too_small (with error bit) if the buffer is too small to store the account data.
- *   F_file_descriptor_max (with error bit) if max file descriptors was reached.
+ *   F_file_descriptor_max (with error bit) if max file descriptors is reached.
  *   F_file_open_max (with error bit) too many open files.
  *   F_input_output (with error bit) if an I/O error occurred.
  *   F_interrupt (with error bit) when program received an interrupt signal, halting operation.
@@ -100,7 +100,7 @@ extern "C" {
  *   F_none on success.
  *
  *   F_buffer_too_small (with error bit) if the buffer is too small to store the account data.
- *   F_file_descriptor_max (with error bit) if max file descriptors was reached.
+ *   F_file_descriptor_max (with error bit) if max file descriptors is reached.
  *   F_file_open_max (with error bit) too many open files.
  *   F_input_output (with error bit) if an I/O error occurred.
  *   F_interrupt (with error bit) when program received an interrupt signal, halting operation.
@@ -127,7 +127,7 @@ extern "C" {
  *   F_none on success.
  *
  *   F_buffer_too_small (with error bit) if the buffer is too small to store the account data.
- *   F_file_descriptor_max (with error bit) if max file descriptors was reached.
+ *   F_file_descriptor_max (with error bit) if max file descriptors is reached.
  *   F_file_open_max (with error bit) too many open files.
  *   F_input_output (with error bit) if an I/O error occurred.
  *   F_interrupt (with error bit) when program received an interrupt signal, halting operation.
@@ -154,7 +154,7 @@ extern "C" {
  *   F_none on success.
  *
  *   F_buffer_too_small (with error bit) if the buffer is too small to store the account data.
- *   F_file_descriptor_max (with error bit) if max file descriptors was reached.
+ *   F_file_descriptor_max (with error bit) if max file descriptors is reached.
  *   F_file_open_max (with error bit) too many open files.
  *   F_input_output (with error bit) if an I/O error occurred.
  *   F_interrupt (with error bit) when program received an interrupt signal, halting operation.
index f8065b055c5459453a7f766527bc171f96d95431..ae23998df852bae2f3fcd4c5139dab89b87c6ca3 100644 (file)
@@ -352,7 +352,7 @@ extern "C" {
  *   F_busy (with error bit) if file is busy.
  *   F_directory (with error bit) if a supposed directory in path is not actually a directory.
  *   F_directory_empty_not (with error bit) if the directory is not empty.
- *   F_file_descriptor_max (with error bit) if max file descriptors was reached.
+ *   F_file_descriptor_max (with error bit) if max file descriptors is reached.
  *   F_file_found_not (with error bit) if file not found.
  *   F_file_open_max (with error bit) too many open files.
  *   F_file_type_directory (with error bit) file is a directory (directories cannot be removed via this function).
@@ -395,7 +395,7 @@ extern "C" {
  *   F_busy (with error bit) if file is busy.
  *   F_directory (with error bit) if a supposed directory in path is not actually a directory.
  *   F_directory_empty_not (with error bit) if the directory is not empty.
- *   F_file_descriptor_max (with error bit) if max file descriptors was reached.
+ *   F_file_descriptor_max (with error bit) if max file descriptors is reached.
  *   F_file_found_not (with error bit) if file not found.
  *   F_file_open_max (with error bit) too many open files.
  *   F_file_type_directory (with error bit) file is a directory (directories cannot be removed via this function).
index 8baff7e902a7a2c23d1f1d6a559dd652e691d196..fb4c9473366721ad94082c30bc98b753898f3f03 100644 (file)
@@ -1905,7 +1905,7 @@ extern "C" {
  *   F_deadlock (with error bit) if operation would cause a deadlock.
  *   F_file_close (with error bit) if fclose() failed for any other reason.
  *   F_file_descriptor (with error bit) if file descriptor is invalid.
- *   F_file_descriptor_max (with error bit) if max file descriptors was reached.
+ *   F_file_descriptor_max (with error bit) if max file descriptors is reached.
  *   F_file_overflow (with error bit) if the write exceeds some implementation defined maximum file size.
  *   F_file_synchronize (with error bit) on flush failure.
  *   F_file_type_not_directory (with error bit) if F_NOTIFY was specified and file.id is not a directory.
@@ -1946,7 +1946,7 @@ extern "C" {
  *   F_buffer (with error bit) if the buffer is invalid.
  *   F_deadlock (with error bit) if operation would cause a deadlock.
  *   F_file_descriptor (with error bit) if file descriptor is invalid.
- *   F_file_descriptor_max (with error bit) if max file descriptors was reached.
+ *   F_file_descriptor_max (with error bit) if max file descriptors is reached.
  *   F_file_type_not_directory (with error bit) if F_NOTIFY was specified and file.id is not a directory.
  *   F_interrupt (with error bit) when program received an interrupt signal, halting operation.
  *   F_lock (with error bit) if failed to lock, such as lock table is full or too many open segments.
index 62580a2c85ced258db66d2344c9423c6db04e6c6..5d9e7a7e6b7d7cb6c4389f8a5b1458d0d8178dce 100644 (file)
@@ -66,7 +66,7 @@ extern "C" {
  * @return
  *   F_none on success but no signal found.
  *   F_device (with error bit) if could not mount the internal inode device.
- *   F_file_descriptor_max (with error bit) if max file descriptors was reached.
+ *   F_file_descriptor_max (with error bit) if max file descriptors is reached.
  *   F_memory_not (with error bit) if out of memory.
  *   F_parameter (with error bit) if a parameter is invalid.
  *   F_failure (with error bit) for any other error.
index 73e53bf347130e933aea9f266166d97449f76d42..7a4f70be7894d1e06fe7d601946e7a56267216c6 100644 (file)
@@ -326,7 +326,7 @@ extern "C" {
  *   F_directory_stream (with error bit) on directory stream error.
  *   F_directory_supported_not (with error bit) on directory file descriptor not supported.
  *   F_failure (with error bit) if failed to read directory information.
- *   F_file_descriptor_max (with error bit) if max file descriptors was reached.
+ *   F_file_descriptor_max (with error bit) if max file descriptors is reached.
  *   F_file_open_max (with error bit) too many open files.
  *   F_memory_not (with error bit) on out of memory.
  *   F_parameter (with error bit) if a parameter is invalid.
index bf4a86ccda633bde1835afc97dcf2e04fa59301b..2f4c354703ba7fe8359afa712b790b00c8a1fd04 100644 (file)
@@ -165,7 +165,7 @@ extern "C" {
  *   F_directory_stream (with error bit) on directory stream error.
  *   F_directory_supported_not (with error bit) on directory file descriptor not supported.
  *   F_failure (with error bit) if failed to read directory information.
- *   F_file_descriptor_max (with error bit) if max file descriptors was reached.
+ *   F_file_descriptor_max (with error bit) if max file descriptors is reached.
  *   F_file_open_max (with error bit) too many open files.
  *   F_memory_not (with error bit) on out of memory.
  *   F_parameter (with error bit) if a parameter is invalid.