Changeset 7c2a3c7 in mainline for uspace/app/cmpdirs/cmpdirs.c

Timestamp:

2026-03-17T12:37:05Z (31 hours ago)

Author:

Vít Skalický <skalicky@…>

Children:

df4f7c30

Parents:

4a998bf9

git-author:

Vít Skalický <skalicky@…> (2026-03-16 13:48:05)

git-committer:

Vít Skalický <skalicky@…> (2026-03-17 12:37:05)

Message:

Improve comments

File:

• uspace/app/cmpdirs/cmpdirs.c (modified) (7 diffs)

uspace/app/cmpdirs/cmpdirs.c

@@ -54 +54 @@
 #define NAME_BUFFER_SIZE 256
 
-// Macros to make handling error less clumbersome
+// Macros to make handling errors less cumbersome
 #define _check_ok(rc, action, ...) if ((rc) != EOK) {fprintf(stderr, __VA_ARGS__); log_msg(LOG_DEFAULT, LVL_ERROR, __VA_ARGS__ ); action; }
+/** Print message (given by the variable arguments) to log and stderr if rc != EOK and then goto the specified label. */
 #define check_ok(rc, label, ...) _check_ok(rc, goto label, __VA_ARGS__)
+/** Print message (given by the variable arguments) to log and stderr if rc != EOK and then break. */
 #define check_ok_break(rc, ...) _check_ok(rc, break, __VA_ARGS__)
 
@@ -139 +141 @@
 }
 
+/** Handles of 2 files or directories to compare */
 struct entry {
         int handle1;
@@ -156 +159 @@
 size_t STACK_INIT_CAPACITY = 256;
 
-/** Create a new growable stack. Don't forget to free it in the end using stack_free */
+/** Create a new growable stack. Don't forget to free it using stack_free when you are done using it. */
 static errno_t stack_new(struct stack* s) {
         s->size = 0;
@@ -201 +204 @@
 }
 
-/** Returns the last entry in the stack and removes it from it. Does not free any memory */
+/** Returns the last entry in the stack and removes it from it. Does not free any memory. */
 static errno_t stack_pop(struct stack *s, struct entry *entry_out) {
         if (s->size == 0) {
@@ -231 +234 @@
 }
 
-/** Compares the contetn of 2 files. It assumes:
+/** Compares the content of 2 files. It assumes:
  *  - both handles represent a file, not dir
  *  - both files have the same size
  *  - both buffers are the size CHUNK_SIZE
- *  - both handle are open for reading */
+ *  - both handles are open for reading */
 static errno_t content_equal(int handle1, vfs_stat_t stat1, char* buffer1, int handle2, vfs_stat_t stat2, char* buffer2, bool *equal_out) {
         errno_t rc = EOK;
@@ -265 +268 @@
 }
 
-/** Checks if the directory/file tree of both handles is equal -- checks presence of files/dirs, content of all files, and metadata. */
 static errno_t trees_equal(int root_handle1, int root_handle2, bool* equal_out) {
-        // todo don't forget to check put/close all file handles
+        // todo Check once again that all file handles are put at the end
         // Performs a depth-first search on handle1 and compares it to handle2.
         errno_t rc = EOK;
@@ -289 +291 @@
 
         char name_buffer[NAME_BUFFER_SIZE];
-
-        // no need to add the initial entry into stack - it's the initial value in the for cycle
-        // rc = stack_append(&s, (struct entry){handle1, handle2});
-        // if (rc != EOK) goto close3;
 
         // While there is something in the stack