Parcourir la source

[1704] Fix comment describing the test in logger_lock_test.cc

Mukund Sivaraman il y a 13 ans
Parent
commit
1c0e6f8026
1 fichiers modifiés avec 5 ajouts et 6 suppressions
  1. 5 6
      src/lib/log/tests/logger_lock_test.cc

+ 5 - 6
src/lib/log/tests/logger_lock_test.cc

@@ -46,13 +46,12 @@ protected:
     }
 };
 
-/// \brief Test InitLogger
+/// \brief Test logger lock sequence
 ///
-/// A program used in testing the logger that initializes logging using
-/// initLogger(), then outputs several messages at different severities and
-/// debug levels.  An external script sets the environment variables and checks
-/// that they have the desired effect.
-
+/// A program used in testing the logger. It verifies that (1) an
+/// interprocess sync lock is first acquired by the logger, (2) the
+/// message is logged by the logger, and (3) the lock is released in
+/// that sequence.
 int
 main(int, char**) {
     initLogger();