From ecd072a286de9343e92f539bee3049b661685d09 Mon Sep 17 00:00:00 2001 From: Axel Kohlmeyer Date: Fri, 11 Feb 2022 08:53:45 -0500 Subject: [PATCH] address spelling issues --- doc/utils/sphinx-config/false_positives.txt | 1 + src/library.cpp | 4 ++-- src/utils.h | 6 ++++-- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/doc/utils/sphinx-config/false_positives.txt b/doc/utils/sphinx-config/false_positives.txt index 408a20f179..1d4c27822b 100644 --- a/doc/utils/sphinx-config/false_positives.txt +++ b/doc/utils/sphinx-config/false_positives.txt @@ -1012,6 +1012,7 @@ fexternal Fexternal ffield ffl +fflush ffmpeg FFmpeg ffplay diff --git a/src/library.cpp b/src/library.cpp index 8c6ee5e774..af5fe36dd0 100644 --- a/src/library.cpp +++ b/src/library.cpp @@ -5442,8 +5442,8 @@ void lammps_fix_external_set_vector(void *handle, const char *id, int idx, doubl /** Flush output buffers \verbatim embed:rst -This function can be used to force output to be written to screen and logfiles -to simplify capturing output from LAMMPS library calls. +This function can be used to flush buffered output to be written to screen +and logfile pointers to simplify capturing output from LAMMPS library calls. \endverbatim * * \param handle pointer to a previously created LAMMPS instance cast to ``void *``. diff --git a/src/utils.h b/src/utils.h index 425fbfe0c1..6811dbe874 100644 --- a/src/utils.h +++ b/src/utils.h @@ -76,8 +76,10 @@ namespace utils { /*! Flush output buffers * - * This function calls fflush on screen and logfile FILE pointers - * if available + * This function calls fflush() on screen and logfile FILE pointers + * if available and thus tells the operating system to output all + * currently buffered data. This is local operation and independent + * from buffering by a file system or an MPI library. */ void flush_buffers(LAMMPS *lmp);