change option name --follow_inodes to --follow-inodes

It would be more natural using '-' for the word separator as
command line.

Note: OptionParser can accept --follow_inodes as well.

Signed-off-by: Daijiro Fukuda <fukuda@clear-code.com>

Author: daipom

README.md

@@ -154,11 +154,11 @@ You can use wildcards:
 $ tailcheck /var/log/td-agent/pos/*
 ```
 
-If you use [follow_inodes](https://docs.fluentd.org/input/tail#follow_inodes), then you must specify `--follow_inodes` option.
+If you use [follow_inodes](https://docs.fluentd.org/input/tail#follow_inodes), then you must specify `--follow-inodes` option.
 (If you have both settings that use `follow_inodes` and those that do not, please run the command separately.)
 
 ```console
-$ tailcheck --follow_inodes /var/log/td-agent/pos/secure
+$ tailcheck --follow-inodes /var/log/td-agent/pos/secure
 ```
 
 You can change the minimum ratio of collection of each target log file by specify `--ratio DECIMAL`.
@@ -287,13 +287,13 @@ Especially, if the `in_tail` uses [follow_inodes](https://docs.fluentd.org/input
 
 `tailcheck` checks the sizes of logfiles based on the paths recorded in the pos files (except already unwatched pos entries).
 
-However, if using `--follow_inodes`, there is a restriction on which files can be checked.
-If using `--follow_inodes`, it is possible that `tailcheck` can not check the already rotated logfiles even if they are recorded in the pos files and are not unwatched yet.
+However, if using `--follow-inodes`, there is a restriction on which files can be checked.
+If using `--follow-inodes`, it is possible that `tailcheck` can not check the already rotated logfiles even if they are recorded in the pos files and are not unwatched yet.
 Since the path recorded in the pos file is not updated after log rotation, the current path and inode may differ.
 `tailcheck` checks only log files whose path and inode in the pos file match.
 At least, it can check the current log files.
 
-If not using `--follow_inodes`, this limitation does not exist.
+If not using `--follow-inodes`, this limitation does not exist.
 
 ## Development
 

lib/fluent/tail_checker/tail_check.rb

@@ -42,14 +42,14 @@ def parse_command_line(argv)
           Usage: tailcheck [OPTIONS] POS_FILE...
           Example: tailcheck /path/to/pos1 /path/to/pos2
           Example: tailcheck /path/to/pos/*
-          Example: tailcheck --follow_inodes /path/to/pos_with_follow_inodes
+          Example: tailcheck --follow-inodes /path/to/pos_with_follow_inodes
 
           If you have any issues with this command, please report it to https://github.com/clear-code/fluent-tail_checker/issues.
 
           Options:
         BANNER
 
-        parser.on("--follow_inodes", "Check the specified pos files with the condition that the follow_inodes feature is enabled.", "Default: Disabled") do
+        parser.on("--follow-inodes", "Check the specified pos files with the condition that the follow_inodes feature is enabled.", "Default: Disabled") do
           @follow_inodes = true
         end
         parser.on("--ratio NUM", Float, "Minimum ratio of collection of each target log file to accept.", "Default: #{@collection_ratio_threshold}") do |v|

test/fluent/tail_checker_test.rb

@@ -20,10 +20,17 @@ class Fluent::TailCheckerTest < Test::Unit::TestCase
     data(
       "Full",
       [
-        ["--follow_inodes", "--ratio", "0.7", "/path/to/pos", "/path/to/pos2"],
+        ["--follow-inodes", "--ratio", "0.7", "/path/to/pos", "/path/to/pos2"],
         { pos_filepaths: ["/path/to/pos", "/path/to/pos2"], follow_inodes: true, collection_ratio_threshold: 0.7 },
       ]
     )
+    data(
+      "--follow_inodes (using underscore)",
+      [
+        ["--follow_inodes", "/path/to/pos"],
+        { pos_filepaths: ["/path/to/pos"], follow_inodes: true, collection_ratio_threshold: 0.5 },
+      ]
+    )
     test "Correct args" do |(args, expected)|
       tail_check = Fluent::TailChecker::TailCheck.new
 

test/script/command-test.bash

@@ -6,4 +6,4 @@ tailcheck --version
 tailcheck --help
 tailcheck test/data/pos_normal
 (! tailcheck test/data/pos_normal test/data/pos_duplicate_unwatched_path)
-tailcheck --follow_inodes test/data/pos_follow_inodes_normal
+tailcheck --follow-inodes test/data/pos_follow_inodes_normal

test/script/command-test.bat

@@ -11,4 +11,4 @@ call tailcheck test/data/pos_normal || exit /b 1
 call tailcheck test/data/pos_normal test/data/pos_duplicate_unwatched_path && exit /b 1
 
 @echo on
-call tailcheck --follow_inodes test/data/pos_follow_inodes_normal || exit /b 1
+call tailcheck --follow-inodes test/data/pos_follow_inodes_normal || exit /b 1