diff options
| author | Charles Giessen <charles@lunarg.com> | 2019-11-01 11:40:27 -0600 |
|---|---|---|
| committer | Charles Giessen <46324611+charles-lunarg@users.noreply.github.com> | 2019-11-01 14:23:01 -0600 |
| commit | 1efe15633cf80f070852ecc54d591b7fb3e2a67e (patch) | |
| tree | 61be4257bc3c699674865e22ed8cd0f7d371fc2d | |
| parent | d5b8bdcdf7f47f9bd7846cd297c506d62c7fe3a4 (diff) | |
| download | usermoji-1efe15633cf80f070852ecc54d591b7fb3e2a67e.tar.xz | |
vulkaninfo: added more documentation for show-formats
The indented behavior was to only show format properties if requested
for text output and always show them for html & json. This commit
modifies the --help output and documentation to better reflect this
behavior.
files modified
- vulkaninfo/vulkaninfo.cpp
- vulkaninfo/vulkaninfo.md
Change-Id: I5e35b8af2db74c37dfadf669ffc81e69304fc4e0
| -rw-r--r-- | vulkaninfo/vulkaninfo.cpp | 4 | ||||
| -rw-r--r-- | vulkaninfo/vulkaninfo.md | 3 |
2 files changed, 6 insertions, 1 deletions
diff --git a/vulkaninfo/vulkaninfo.cpp b/vulkaninfo/vulkaninfo.cpp index f12b370f..fae81475 100644 --- a/vulkaninfo/vulkaninfo.cpp +++ b/vulkaninfo/vulkaninfo.cpp @@ -668,7 +668,9 @@ void print_usage(const char *argv0) { std::cout << " specifying the gpu-number associated with the gpu of \n"; std::cout << " interest. This number can be determined by running\n"; std::cout << " vulkaninfo without any options specified.\n"; - std::cout << "--show-formats Display the format properties of each physical device.\n\n"; + std::cout << "--show-formats Display the format properties of each physical device.\n"; + std::cout << " Note: This option does not affect html or json output;\n"; + std::cout << " they will always print format properties.\n\n"; } int main(int argc, char **argv) { diff --git a/vulkaninfo/vulkaninfo.md b/vulkaninfo/vulkaninfo.md index 09cfdd10..48255962 100644 --- a/vulkaninfo/vulkaninfo.md +++ b/vulkaninfo/vulkaninfo.md @@ -61,6 +61,9 @@ OPTIONS: interest. This number can be determined by running vulkaninfo without any options specified. --show-formats Display the format properties of each physical device. + Note: This option does not affect html or json output; + they will always print format properties. + ``` ### Windows |