Make DISABLED_LINE related comments understandable

nil0x42 · Sep 4, 2020 · 9f0a382 · 9f0a382
1 parent 728cf80
commit 9f0a382
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 6 deletions.
diff --git a/include/const.h b/include/const.h
@@ -13,7 +13,7 @@
 /* medium line size for determining hashmap min size */
 #define MEDIUM_LINE_BYTES       (8)
 
-/* this char is written at start of lines as a `removal mark` */
+/* char used to mark duplicate lines for removal */
 #define DISABLED_LINE           '\0'
 
 /* enable/disable multithreading feature */

diff --git a/src/chunk.c b/src/chunk.c
@@ -63,8 +63,8 @@ bool        get_next_chunk(t_chunk *chunk, struct file *file)
 }
 
 
-/** Apply 'zero tag' (DISABLED_LINE) on each `chunk`
- * line that is already present in `hmap`.
+/** Disable lines on `chunk` that already exist in `hmap`
+ * by tagging them with 'DISABLED_LINE'
  * Main work for threads in thread pool.
  */
 void        cleanout_chunk(t_chunk *chunk)
@@ -79,7 +79,6 @@ void        cleanout_chunk(t_chunk *chunk)
         {
             if (cmp_line(&line, &g_hmap.ptr[slot]) == 0)
             {
-                /* apply 'zero tag' */
                 LINE_ADDR(line)[0] = DISABLED_LINE;
                 break;
             }

diff --git a/src/hmap.c b/src/hmap.c
@@ -60,7 +60,6 @@ void        populate_hmap(t_chunk *chunk)
             }
             else if (cmp_line(&line, &g_hmap.ptr[slot]) == 0)
             {
-                /* apply 'zero tag' */
                 LINE_ADDR(line)[0] = DISABLED_LINE;
                 break;
             }

diff --git a/src/main.c b/src/main.c
@@ -28,7 +28,7 @@ struct file *g_file;
 struct hmap g_hmap;
 
 
-/** Rewrite file without zero-tagged lines, and update file size.
+/** Rewrite file, ignoring lines tagged with 'DISABLED_LINE'
  */
 static void     remove_duplicates(void)
 {