All of lore.kernel.org
 help / color / mirror / Atom feed
From: Luben Tuikov <luben.tuikov@amd.com>
To: <amd-gfx@lists.freedesktop.org>
Cc: "Alex Deucher" <Alexander.Deucher@amd.com>,
	"Pierre-Eric Pelloux-Prayer" <pierre-eric.pelloux-prayer@amd.com>,
	"Luben Tuikov" <luben.tuikov@amd.com>,
	"Christian König" <christian.koenig@amd.com>,
	"Tom StDenis" <tom.stdenis@amd.com>
Subject: [PATCH 6/6] umr: Add FILES section to the man page
Date: Wed, 23 Mar 2022 07:48:42 -0400	[thread overview]
Message-ID: <20220323114842.78516-7-luben.tuikov@amd.com> (raw)
In-Reply-To: <20220323114842.78516-1-luben.tuikov@amd.com>

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@amd.com>
Cc: Pierre-Eric Pelloux-Prayer <pierre-eric.pelloux-prayer@amd.com>
Cc: Tom StDenis <tom.stdenis@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Signed-off-by: Luben Tuikov <luben.tuikov@amd.com>
---
 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


  parent reply	other threads:[~2022-03-23 11:49 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-23 11:48 [PATCH 0/6] Complete and add dynamic completion to umr Luben Tuikov
2022-03-23 11:48 ` [PATCH 1/6] umr: Rename "scripts/umr" --> "scripts/umr-completion.bash" Luben Tuikov
2022-03-23 11:48 ` [PATCH 2/6] umr: Rename completion function Luben Tuikov
2022-03-23 11:48 ` [PATCH 3/6] umr: Complete umr completion Luben Tuikov
2022-03-23 11:48 ` [PATCH 4/6] umr: Replace and reuse asic.ipblock.reg completion Luben Tuikov
2022-03-23 11:48 ` [PATCH 5/6] umr: Replace and reuse ipblock completion Luben Tuikov
2022-03-23 11:48 ` Luben Tuikov [this message]
2022-03-23 12:01 ` [PATCH 0/6] Complete and add dynamic completion to umr StDenis, Tom

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220323114842.78516-7-luben.tuikov@amd.com \
    --to=luben.tuikov@amd.com \
    --cc=Alexander.Deucher@amd.com \
    --cc=amd-gfx@lists.freedesktop.org \
    --cc=christian.koenig@amd.com \
    --cc=pierre-eric.pelloux-prayer@amd.com \
    --cc=tom.stdenis@amd.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.