From d64db6bad79e10f92c56e5572d6ae9072d62b3a3 Mon Sep 17 00:00:00 2001 From: Tavian Barnes Date: Fri, 1 Feb 2019 00:04:33 -0500 Subject: Add some documentation comments --- stat.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'stat.h') diff --git a/stat.h b/stat.h index d9c9588..3887db4 100644 --- a/stat.h +++ b/stat.h @@ -1,6 +1,6 @@ /**************************************************************************** * bfs * - * Copyright (C) 2018 Tavian Barnes * + * Copyright (C) 2018-2019 Tavian Barnes * * * * Permission to use, copy, modify, and/or distribute this software for any * * purpose with or without fee is hereby granted. * @@ -14,6 +14,14 @@ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. * ****************************************************************************/ +/** + * A facade over the stat() API that unifies some details that diverge between + * implementations, like the names of the timespec fields and the presence of + * file "birth" times. On new enough Linux kernels, the facade is backed by + * statx() instead, and so it exposes a similar interface with a mask for which + * fields were successfully returned. + */ + #ifndef BFS_STAT_H #define BFS_STAT_H -- cgit v1.2.3