Add FILES section to the man page with entries the completion file and the
umr database tree root.
Reword the entry of the UMR_DATABASE_PATH to make it clearer that the user
should set this up.
Update the man page's copyright year and month.
Cc: Alex Deucher <Alexander.Deucher@xxxxxxx>
Cc: Pierre-Eric Pelloux-Prayer <pierre-eric.pelloux-prayer@xxxxxxx>
Cc: Tom StDenis <tom.stdenis@xxxxxxx>
Cc: Christian König <christian.koenig@xxxxxxx>
Signed-off-by: Luben Tuikov <luben.tuikov@xxxxxxx>
---
doc/umr.1 | 13 +++++++++++--
1 file changed, 11 insertions(+), 2 deletions(-)
diff --git a/doc/umr.1 b/doc/umr.1
index 575b522ad22e78..62eea7db320b88 100644
--- a/doc/umr.1
+++ b/doc/umr.1
@@ -1,4 +1,4 @@
-.TH UMR 1 "January 2020" "AMD (c) 2020" "User Manuals"
+.TH UMR 1 "February 2022" "AMD (c) 2022" "User Manuals"
.SH NAME
umr \- AMDGPU Userspace Register Debugger
.SH DESCRIPTION
@@ -306,4 +306,13 @@ GPU hangs occur frequently. When PG is enabled it will read a constant 0.
Directory to output "umr.log" file when capturing samples with the --top command.
.B UMR_DATABASE_PATH
- Directory start of database tree used for register, ip, and asic model data.
+ Should be set to the top directory of the database tree used for register, IP, and ASIC model data.
+
+.SH FILES
+.B ${CMAKE_INSTALL_PREFIX}/share/bash-completion/completions/umr
+contains completion for bash shells. You'd normally source this file in your ~/.bashrc.
+
+.B ${CMAKE_INSTALL_PREFIX}/share/umr/database
+contains database files for ASICs, IPs, and registers.
+.B UMR_DATABASE_PATH
+is usually set to point to here.
--
2.35.1.607.gf01e51a7cf
