Messages in this thread | | | Date | Mon, 23 Oct 2006 14:32:54 +0200 | From | Michael Holzheu <> | Subject | How to document dimension units for virtual files? |
| |
For the s390 hypervisor filesystem (s390_hypfs) we export performance and status information to user space. In order to make parsing for programs as easy as possilbe, we export exactly one value in one file without adding the dimension unit to the output string.
For example:
cat /hypfs/cpus/onlinetime 476362365
cat /hypfs/memory 900620
As far as I know that is the recommended way of exporting such data to user space, right?
The question is how to provide the dimension unit information to the user.
I see three possibilites:
1. Write dimension unit into the output string (e.g. "476362365 kB"), which makes parsing a bit more complicated.
2. Encode dimension unit into filename (e.g. onlinetime_ms or memory_kb)
3. Document dimension unit somewhere. In that case we need some central place to provide such information. E.g. in the Documentation directory of the linux kernel.
So, what is the recommended way?
Thanks!
Michael - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
| |