Clean-up: unify comment style
authorJérémie Galarneau <jeremie.galarneau@efficios.com>
Thu, 24 Oct 2024 21:01:44 +0000 (17:01 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Fri, 25 Oct 2024 14:25:49 +0000 (10:25 -0400)
Some comment blocks use /** in lieu of /* on the first line. Since the
latter style is prevalent in the code base, replace all instances to
attain One True Style.

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: Ica1aee472bdbeaaa40ee32f67274e3c43f7f9850

16 files changed:
src/bin/lttng-sessiond/modprobe.cpp
src/bin/lttng-sessiond/notification-thread-events.hpp
src/bin/lttng-sessiond/notification-thread.hpp
src/bin/lttng-sessiond/session.hpp
src/common/align.hpp
src/common/buffer-view.hpp
src/common/bug.hpp
src/common/exception.hpp
src/common/payload-view.hpp
src/common/payload.hpp
src/common/utils.cpp
tests/utils/bt2_plugins/field_stats/field_stats.cpp
tests/utils/bt2_plugins/field_stats/field_stats.hpp
tests/utils/tap/clock.cpp
tests/utils/testapp/gen-syscall-events-callstack/gen-syscall-events-callstack.c
tests/utils/xml-utils/extract_xml.cpp

index d14dd7dfc754f64eb1e9bfbdcab1b666c69981b1..fd72f7ee94fd253080d1c1a65d4667cc7b93595b 100644 (file)
@@ -6,7 +6,7 @@
  *
  */
 
-/**
+/*
  * @file modprobe.c
  *
  * @brief modprobe related functions.
@@ -316,7 +316,7 @@ static int probes_capacity;
 #ifdef HAVE_KMOD
 #include <libkmod.h>
 
-/**
+/*
  * @brief Logging function for libkmod integration.
  */
 static ATTR_FORMAT_PRINTF(6, 0) void log_kmod(void *data __attribute__((unused)),
@@ -337,7 +337,7 @@ static ATTR_FORMAT_PRINTF(6, 0) void log_kmod(void *data __attribute__((unused))
        free(str);
 }
 
-/**
+/*
  * @brief Setup the libkmod context.
  *
  * Create the context, add a custom logging function and preload the
@@ -376,7 +376,7 @@ error:
        return ret;
 }
 
-/**
+/*
  * @brief Loads the kernel modules in \p modules
  *
  * @param modules      List of modules to load
@@ -435,7 +435,7 @@ error:
        return ret;
 }
 
-/**
+/*
  * @brief Recursively unload modules.
  *
  * This function implements the same modules unloading behavior as
@@ -476,7 +476,7 @@ static int rmmod_recurse(struct kmod_module *mod)
        return ret;
 }
 
-/**
+/*
  * @brief Unloads the kernel modules in \p modules
  *
  * @param modules      List of modules to unload
@@ -672,7 +672,7 @@ int modprobe_lttng_control()
        return modprobe_lttng(kern_modules_control_core, ARRAY_SIZE(kern_modules_control_core));
 }
 
-/**
+/*
  * Grow global list of probes (double capacity or set it to 1 if
  * currently 0 and copy existing data).
  */
index 955b16cddd299c0bacb1b00929e6d7fe645c4bc1..68082cbb592554d33f5c3cbbb9c0abe242e40a24 100644 (file)
@@ -12,7 +12,7 @@
 
 #include <lttng/domain.h>
 
-/**
+/*
  * Event handling function shall only return an error if
  * the thread should be stopped.
  */
index c995fc951d8e515c30c1c237b6be25b894bf20eb..884149c5657b1545e68b5297f5b16dcb8098fd11 100644 (file)
@@ -83,7 +83,7 @@ struct notification_thread_handle {
        sem_t ready;
 };
 
-/**
+/*
  * This thread maintains an internal state associating clients and triggers.
  *
  * In order to speed-up and simplify queries, hash tables providing the
index b091c2ef3d0c17d5c89d3590db71f82e4d9190b3..c082afc30f222d8f30f30dbbb958846850133007 100644 (file)
@@ -476,7 +476,7 @@ namespace sessiond {
 std::unique_lock<std::mutex> lock_session_list();
 
 namespace exceptions {
-/**
+/*
  * @class session_not_found_error
  * @brief Represents a session-not-found error and provides the parameters used to query the session
  * for use by error-reporting code.
index fab15af8c77619c5b68a79e9c7d7c70b69911637..fc58a776bba0db3ede7854e6dd3a727fd0eb8ce7 100644 (file)
@@ -26,7 +26,7 @@
 
 #define lttng_align_floor(v, align) __lttng_align_floor_mask(v, (__typeof__(v)) (align) -1)
 
-/**
+/*
  * lttng_offset_align - Calculate the offset needed to align an object on its natural
  *                alignment towards higher addresses.
  * @align_drift:  object offset from an "alignment"-aligned address.
@@ -41,7 +41,7 @@
                (((alignment) - (align_drift)) & ((alignment) -1));                               \
        })
 
-/**
+/*
  * lttng_offset_align_floor - Calculate the offset needed to align an object
  *                      on its natural alignment towards lower addresses.
  * @align_drift:  object offset from an "alignment"-aligned address.
index 131275af2805e3279ed55c18edb270dc1a53a9ff..ba9211c9da29a4708626d2c5a030ccc780740519 100644 (file)
@@ -21,7 +21,7 @@ struct lttng_buffer_view {
        size_t size;
 };
 
-/**
+/*
  * Return a buffer view referencing a subset of the memory referenced by a raw
  * pointer.
  *
@@ -34,7 +34,7 @@ struct lttng_buffer_view {
  */
 struct lttng_buffer_view lttng_buffer_view_init(const char *src, size_t offset, ptrdiff_t len);
 
-/**
+/*
  * Checks if a buffer view is safe to access.
  *
  * After calling the buffer view creation functions, callers should verify
@@ -45,7 +45,7 @@ struct lttng_buffer_view lttng_buffer_view_init(const char *src, size_t offset,
  */
 bool lttng_buffer_view_is_valid(const struct lttng_buffer_view *view);
 
-/**
+/*
  * Return a buffer view referencing a subset of the memory referenced by another
  * view.
  *
@@ -61,7 +61,7 @@ bool lttng_buffer_view_is_valid(const struct lttng_buffer_view *view);
 struct lttng_buffer_view
 lttng_buffer_view_from_view(const struct lttng_buffer_view *src, size_t offset, ptrdiff_t len);
 
-/**
+/*
  * Return a buffer view referencing a subset of the memory referenced by a
  * dynamic buffer.
  *
@@ -77,7 +77,7 @@ lttng_buffer_view_from_view(const struct lttng_buffer_view *src, size_t offset,
 struct lttng_buffer_view lttng_buffer_view_from_dynamic_buffer(
        const struct lttng_dynamic_buffer *src, size_t offset, ptrdiff_t len);
 
-/**
+/*
  * Verify that `buf` contains a string starting at `str` of length
  * `len_with_null_terminator`.
  *
index 758fcf70c5be9d176ac6f5e97ad1963dde1b7d20..e4ae768657bcfc27590c3dd3423fbcb03dcc932b 100644 (file)
@@ -22,7 +22,7 @@
 
 #define LTTNG_BUILD_BUG_ON(condition) ((void) sizeof(char[-!!(condition)]))
 
-/**
+/*
  * LTTNG_BUILD_RUNTIME_BUG_ON - check condition at build (if constant) or runtime
  * @condition: the condition which should be false.
  *
index 35f80ba1719d61afe92c1a5ab45e210aa4a0f11e..da6997d4207ffc080e69e6db98818aec8675ef3c 100644 (file)
@@ -35,7 +35,7 @@
        throw lttng::invalid_argument_error(msg, LTTNG_SOURCE_LOCATION())
 
 namespace lttng {
-/**
+/*
  * @class source_location
  * @brief Represents the location in the source code where an exception was thrown.
  *
@@ -73,7 +73,7 @@ public:
        unsigned int line_number;
 };
 
-/**
+/*
  * @class runtime_error
  * @brief Base type for all LTTng exceptions.
  *
@@ -95,7 +95,7 @@ public:
        lttng::source_location source_location;
 };
 
-/**
+/*
  * @class allocation_failure
  * @brief Represents an allocation failure.
  *
@@ -111,7 +111,7 @@ public:
        std::size_t allocation_size;
 };
 
-/**
+/*
  * @class out_of_range
  * @brief Represents an out of range access error.
  *
@@ -124,7 +124,7 @@ public:
                              const lttng::source_location& source_location);
 };
 
-/**
+/*
  * @class unsupported_error
  * @brief Represents an error for unsupported features.
  *
@@ -138,7 +138,7 @@ public:
 };
 
 namespace ctl {
-/**
+/*
  * @class error
  * @brief Wraps lttng_error_code errors for reporting through liblttng-ctl's interface.
  *
@@ -162,7 +162,7 @@ private:
 };
 } /* namespace ctl */
 
-/**
+/*
  * @class posix_error
  * @brief Wraps a POSIX system error, including the location where the error occurred.
  */
@@ -173,7 +173,7 @@ public:
                             const lttng::source_location& source_location);
 };
 
-/**
+/*
  * @class communication_error
  * @brief Base class for communication errors between components.
  */
@@ -183,7 +183,7 @@ public:
                                     const lttng::source_location& source_location);
 };
 
-/**
+/*
  * @class protocol_error
  * @brief Base class for protocol layer communication errors (encoding or decoding problems).
  */
@@ -193,7 +193,7 @@ public:
                                const lttng::source_location& source_location);
 };
 
-/**
+/*
  * @class invalid_argument_error
  * @brief Represents an error for invalid arguments.
  */
index 1980c0a2f53592204ae29e54297c211ebce64c8c..b0523352329056cfea8345f3f198543e39533997 100644 (file)
@@ -55,7 +55,7 @@ struct lttng_payload_view {
        } _iterator;
 };
 
-/**
+/*
  * Checks if a payload view's buffer is safe to access.
  *
  * After calling the payload view creation functions, callers should verify
@@ -66,7 +66,7 @@ struct lttng_payload_view {
  */
 bool lttng_payload_view_is_valid(const struct lttng_payload_view *view);
 
-/**
+/*
  * Return a payload view referencing a subset of a payload.
  *
  * @payload    Source payload to reference
@@ -78,7 +78,7 @@ bool lttng_payload_view_is_valid(const struct lttng_payload_view *view);
 struct lttng_payload_view
 lttng_payload_view_from_payload(const struct lttng_payload *payload, size_t offset, ptrdiff_t len);
 
-/**
+/*
  * Return a payload view referencing a subset of a payload referenced by
  * another payload view.
  *
@@ -91,7 +91,7 @@ lttng_payload_view_from_payload(const struct lttng_payload *payload, size_t offs
 struct lttng_payload_view
 lttng_payload_view_from_view(struct lttng_payload_view *view, size_t offset, ptrdiff_t len);
 
-/**
+/*
  * Return a payload view referencing a subset of a dynamic buffer.
  *
  * Meant as an adapter for code paths that need to create a payload view
@@ -105,7 +105,7 @@ lttng_payload_view_from_view(struct lttng_payload_view *view, size_t offset, ptr
  */
 struct lttng_payload_view lttng_payload_view_from_dynamic_buffer(
        const struct lttng_dynamic_buffer *buffer, size_t offset, ptrdiff_t len);
-/**
+/*
  *
  * Return a payload view referencing a subset of a dynamic buffer.
  *
@@ -122,7 +122,7 @@ struct lttng_payload_view lttng_payload_view_from_buffer_view(const struct lttng
                                                              size_t offset,
                                                              ptrdiff_t len);
 
-/**
+/*
  * Return a payload view referencing a subset of the memory referenced by a raw
  * pointer.
  *
@@ -136,7 +136,7 @@ struct lttng_payload_view lttng_payload_view_from_buffer_view(const struct lttng
 struct lttng_payload_view
 lttng_payload_view_init_from_buffer(const char *src, size_t offset, ptrdiff_t len);
 
-/**
+/*
  * Get the number of file descriptor handles left in a payload view.
  *
  * @payload    Payload instance
@@ -145,7 +145,7 @@ lttng_payload_view_init_from_buffer(const char *src, size_t offset, ptrdiff_t le
  */
 int lttng_payload_view_get_fd_handle_count(const struct lttng_payload_view *payload_view);
 
-/**
+/*
  * Pop an fd handle from a payload view.
  *
  * A reference to the returned fd_handle is acquired on behalf of the caller.
index 0e27efa2c2799a1d6814e16983b6a7f5f8229c7c..a6f1dd593c4581407686e34643f2434fa30fc8bb 100644 (file)
@@ -44,7 +44,7 @@ void lttng_payload_reset(struct lttng_payload *payload);
  */
 void lttng_payload_clear(struct lttng_payload *payload);
 
-/**
+/*
  * Add an fd to the payload.
  * The payload acquires a reference to the fd_handle.
  *
index f1be2c39ed438e12abe04355688c253c30cbe17d..c6b9a55b135e5ee4da511ad5c250e19f86f1387b 100644 (file)
@@ -354,7 +354,7 @@ int utils_stream_file_path(const char *path_name,
        return ret;
 }
 
-/**
+/*
  * Parse a string that represents a size in human readable format. It
  * supports decimal integers suffixed by 'k', 'K', 'M' or 'G'.
  *
@@ -451,7 +451,7 @@ end:
        return ret;
 }
 
-/**
+/*
  * Parse a string that represents a time in human readable format. It
  * supports decimal integers suffixed by:
  *     "us" for microsecond,
@@ -709,7 +709,7 @@ int utils_get_count_order_u64(uint64_t x)
        return fls_u64(x - 1);
 }
 
-/**
+/*
  * Obtain the value of LTTNG_HOME environment variable, if exists.
  * Otherwise returns the value of HOME.
  */
@@ -740,7 +740,7 @@ end:
        return val;
 }
 
-/**
+/*
  * Get user's home directory. Dynamically allocated, must be freed
  * by the caller.
  */
index e3be5558ff9b5a148e27753b2414b9dd6c29985b..c4e9b69041b00b5817c1545899bfa1b814827e12 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (C) 2023 Kienan Stewart <kstewart@efficios.com>
  *
  * SPDX-License-Identifier: LGPL-2.1-only
index b1977af049a95060fb984316d104c1df344c8203..a1fb1951774cf68133ef96852b3e536538e5f46a 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (C) 2023 Kienan Stewart <kstewart@efficios.com>
  *
  * SPDX-License-Identifier: LGPL-2.1-only
index 9af321ff92ed97b8c59f36ee1c5fdda439832b36..bc4f2f2fee941fcd6fa5cfe06b1ff302e525e6e1 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (C) 2023 Kienan Stewart <kstewart@efficios.com>
  *
  * SPDX-License-Identifier: LGPL-2.1-only
index bee03a42ce2148e0fdb72476eea0d37c5478c367..deb035a3b46cc240d77437410b59555e387eb34a 100644 (file)
@@ -17,7 +17,7 @@
 #include <sys/types.h>
 #include <unistd.h>
 
-/**
+/*
  * The process waits for the creation of a file passed as argument from an
  * external processes to execute a syscall and exiting. This is useful for tests
  * in combinaison with LTTng's PID tracker feature where we can trace the kernel
index 2531d0832e0ea071db9ef10adc04fec9b6c0e0a2..850ed8ccbbf61c05fc22e9204ec99e4f0453faf2 100644 (file)
@@ -46,7 +46,7 @@ static int opt_verbose;
 static int node_exist;
 static bool result = false;
 
-/**
+/*
  * print_xpath_nodes:
  * nodes:  the nodes set.
  * output: the output file handle.
This page took 0.034559 seconds and 4 git commands to generate.