[libcamera-devel,2/5] libcamera: base: log: Replace stderr with std::cerr in documentation
diff mbox series

Message ID 20220525222503.6460-3-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • libcamera: Add colors to the log
Related show

Commit Message

Laurent Pinchart May 25, 2022, 10:25 p.m. UTC
While std::cerr and stderr both target the same file by default, this
may be overridden by applications. Update the documentation to use
std::cerr instead of stderr to be accurate.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/libcamera/base/log.cpp | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

Comments

Umang Jain May 29, 2022, 11:23 a.m. UTC | #1
Hello,

Thank you for the patch,

On 5/26/22 00:25, Laurent Pinchart via libcamera-devel wrote:
> While std::cerr and stderr both target the same file by default, this
> may be overridden by applications. Update the documentation to use
> std::cerr instead of stderr to be accurate.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>


Reviewed-by: Umang Jain <umang.jain@ideasonboard.com>

> ---
>   src/libcamera/base/log.cpp | 11 ++++++-----
>   1 file changed, 6 insertions(+), 5 deletions(-)
>
> diff --git a/src/libcamera/base/log.cpp b/src/libcamera/base/log.cpp
> index df84ba4e8328..9ae62368a54d 100644
> --- a/src/libcamera/base/log.cpp
> +++ b/src/libcamera/base/log.cpp
> @@ -46,11 +46,11 @@
>    * their category are output to the log, while other messages are silently
>    * discarded.
>    *
> - * By default log messages are output to stderr. They can be redirected to a log
> - * file by setting the LIBCAMERA_LOG_FILE environment variable to the name of
> - * the file. The file must be writable and is truncated if it exists. If any
> + * By default log messages are output to std::cerr. They can be redirected to a
> + * log file by setting the LIBCAMERA_LOG_FILE environment variable to the name
> + * of the file. The file must be writable and is truncated if it exists. If any
>    * error occurs when opening the file, the file is ignored and the log is output
> - * to stderr.
> + * to std::cerr.
>    */
>   
>   /**
> @@ -527,7 +527,8 @@ Logger::Logger()
>    * If the LIBCAMERA_LOG_FILE environment variable is set, open the file it
>    * points to and redirect the logger output to it. If the environment variable
>    * is set to "syslog", then the logger output will be directed to syslog. Errors
> - * are silently ignored and don't affect the logger output (set to stderr).
> + * are silently ignored and don't affect the logger output (set to std::cerr by
> + * default).
>    */
>   void Logger::parseLogFile()
>   {
Nicolas Dufresne via libcamera-devel May 31, 2022, 3:20 a.m. UTC | #2
Hi Laurent,

On Thu, May 26, 2022 at 01:25:00AM +0300, Laurent Pinchart via libcamera-devel wrote:
> While std::cerr and stderr both target the same file by default, this
> may be overridden by applications. Update the documentation to use
> std::cerr instead of stderr to be accurate.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>

> ---
>  src/libcamera/base/log.cpp | 11 ++++++-----
>  1 file changed, 6 insertions(+), 5 deletions(-)
> 
> diff --git a/src/libcamera/base/log.cpp b/src/libcamera/base/log.cpp
> index df84ba4e8328..9ae62368a54d 100644
> --- a/src/libcamera/base/log.cpp
> +++ b/src/libcamera/base/log.cpp
> @@ -46,11 +46,11 @@
>   * their category are output to the log, while other messages are silently
>   * discarded.
>   *
> - * By default log messages are output to stderr. They can be redirected to a log
> - * file by setting the LIBCAMERA_LOG_FILE environment variable to the name of
> - * the file. The file must be writable and is truncated if it exists. If any
> + * By default log messages are output to std::cerr. They can be redirected to a
> + * log file by setting the LIBCAMERA_LOG_FILE environment variable to the name
> + * of the file. The file must be writable and is truncated if it exists. If any
>   * error occurs when opening the file, the file is ignored and the log is output
> - * to stderr.
> + * to std::cerr.
>   */
>  
>  /**
> @@ -527,7 +527,8 @@ Logger::Logger()
>   * If the LIBCAMERA_LOG_FILE environment variable is set, open the file it
>   * points to and redirect the logger output to it. If the environment variable
>   * is set to "syslog", then the logger output will be directed to syslog. Errors
> - * are silently ignored and don't affect the logger output (set to stderr).
> + * are silently ignored and don't affect the logger output (set to std::cerr by
> + * default).
>   */
>  void Logger::parseLogFile()
>  {

Patch
diff mbox series

diff --git a/src/libcamera/base/log.cpp b/src/libcamera/base/log.cpp
index df84ba4e8328..9ae62368a54d 100644
--- a/src/libcamera/base/log.cpp
+++ b/src/libcamera/base/log.cpp
@@ -46,11 +46,11 @@ 
  * their category are output to the log, while other messages are silently
  * discarded.
  *
- * By default log messages are output to stderr. They can be redirected to a log
- * file by setting the LIBCAMERA_LOG_FILE environment variable to the name of
- * the file. The file must be writable and is truncated if it exists. If any
+ * By default log messages are output to std::cerr. They can be redirected to a
+ * log file by setting the LIBCAMERA_LOG_FILE environment variable to the name
+ * of the file. The file must be writable and is truncated if it exists. If any
  * error occurs when opening the file, the file is ignored and the log is output
- * to stderr.
+ * to std::cerr.
  */
 
 /**
@@ -527,7 +527,8 @@  Logger::Logger()
  * If the LIBCAMERA_LOG_FILE environment variable is set, open the file it
  * points to and redirect the logger output to it. If the environment variable
  * is set to "syslog", then the logger output will be directed to syslog. Errors
- * are silently ignored and don't affect the logger output (set to stderr).
+ * are silently ignored and don't affect the logger output (set to std::cerr by
+ * default).
  */
 void Logger::parseLogFile()
 {