From Andrew Lindesay <apl@xxxxxxxxxxxxxx>:
Andrew Lindesay has uploaded this change for review. (
https://review.haiku-os.org/c/haiku/+/2285 ;)
Change subject: HaikuDepot: Instructions on Logs
......................................................................
HaikuDepot: Instructions on Logs
Some error messages make mention of application logs
and users don't know how to view the logs. This
change adds some instructions about that to the user
guide and also directs the user to the user guide in
any error messages that mention the logs.
---
M docs/userguide/en/applications/haikudepot.html
M src/apps/haikudepot/HaikuDepotConstants.h
M src/apps/haikudepot/ui/MainWindow.cpp
M src/apps/haikudepot/ui/UserLoginWindow.cpp
M src/apps/haikudepot/ui/UserUsageConditionsWindow.cpp
5 files changed, 23 insertions(+), 3 deletions(-)
git pull ssh://git.haiku-os.org:22/haiku refs/changes/85/2285/1
diff --git a/docs/userguide/en/applications/haikudepot.html
b/docs/userguide/en/applications/haikudepot.html
index 71fcb6f..ca53974 100644
--- a/docs/userguide/en/applications/haikudepot.html
+++ b/docs/userguide/en/applications/haikudepot.html
@@ -9,6 +9,7 @@
*
* Authors:
* Humdinger <humdingerb@xxxxxxxxx>
+ * Andrew Lindesay <apl@xxxxxxxxxxxxxx>
*
-->
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
@@ -153,6 +154,19 @@
<p>Here you move the mouse over the stars to light them up and choose your
rating, you can also choose from a number of levels to judge the stability of
the application and pick the language of your optional comment. To make a
comment meaningful, you should have worked with the application you're about to
rate for a while to become familiar with its features, bugs and quirks. And
don't write the next great American novel... keep it short, sweet and polite.
:)<br />
After you click <span class="button">Send</span> the data is transmitted to
the server. You may have to go to the <span class="menu">Tools</span> menu to
<span class="menu">Refresh repositories</span> before you can see your
changes.</p>
<p>At any time, you can come back and edit your comment and re-rate it. You
can also hide your rating from other users by deactivating the checkbox <span
class="menu">Other users can see this rating</span>.</p>
+
+<h2><a href="#"><img src="../../images/up.png" style="border:none;float:right"
alt="index" /></a>
+<a id="logs" name="logs">Diagnostic Logs</a></h2>
+<p>As HaikuDepot is used, it makes complex interactions with network as well
as local services. Things can go wrong in these interactions. The cause of a
given problem can be something which was unexpected at the time that the
application was written and so a very specific error message was not able to be
provided. HaikuDepot outputs some text, usually hidden from end users, that
provides a diagnostic log of what the application does. Sometimes being able
to get a copy of this diagnostic log is very helpful in diagnosing and then
fixing a bug in the software.</p>
+<p>You may be presented with an error message from the HaikuDepot application
that suggests viewing the logs to get further in-depth information or you may
have lodged an issue in the Haiku <a href="https://dev.haiku-os.org/";>bug
tracking system</a> and you have been subsequently asked to provide the logs to
help understand the problem.</p>
+<p>To see the diagnostic logs, HaikuDepot needs to be started from the <a
href="terminal.html">Terminal</a> application that is included with your Haiku
installation. Open the <a href="terminal.html">Terminal</a> application and
start Haiku with the following terminal command;</p>
+
+<pre>/boot/system/apps/HaikuDepot -v debug</pre>
+
+<p>The command uses the <code>-v</code> flag to control the verbosity of the
diagnostic logs. Possible values are; <code>off</code>, <code>info</code>,
<code>debug</code> and <code>trace</code>. Using the <code>off</code> value
will provide a small quantity of logging and using the <code>trace</code> value
will yield the largest quantity of logging in high detail.</p>
+
+<p>As HaikuDepot starts-up you will see a text shown in the terminal window;
this is the diagnostic logging.</p>
+
</div>
</div>
diff --git a/src/apps/haikudepot/HaikuDepotConstants.h
b/src/apps/haikudepot/HaikuDepotConstants.h
index 4e79b34..ba01cd0 100644
--- a/src/apps/haikudepot/HaikuDepotConstants.h
+++ b/src/apps/haikudepot/HaikuDepotConstants.h
@@ -78,4 +78,7 @@
#define STR_MDASH "\xE2\x80\x94"
+#define ALERT_MSG_LOGS_USER_GUIDE "Information about how to view the logs is "
\
+ "available in the HaikuDepot section of the user guide."
+
#endif // HAIKU_DEPOT_CONSTANTS_H
\ No newline at end of file
diff --git a/src/apps/haikudepot/ui/MainWindow.cpp
b/src/apps/haikudepot/ui/MainWindow.cpp
index f2c8a99..1882c39 100644
--- a/src/apps/haikudepot/ui/MainWindow.cpp
+++ b/src/apps/haikudepot/ui/MainWindow.cpp
@@ -972,7 +972,8 @@
"that may cause data to be outdated or missing
from the "
"application's display. Additional details
regarding this "
"problem may be able to be obtained from the
application "
- "logs."));
+ "logs."
+ ALERT_MSG_LOGS_USER_GUIDE));
}
BMessenger messenger(this);
messenger.SendMessage(MSG_BULK_LOAD_DONE);
diff --git a/src/apps/haikudepot/ui/UserLoginWindow.cpp
b/src/apps/haikudepot/ui/UserLoginWindow.cpp
index 6a4e5eb..23b90c9 100644
--- a/src/apps/haikudepot/ui/UserLoginWindow.cpp
+++ b/src/apps/haikudepot/ui/UserLoginWindow.cpp
@@ -785,7 +785,8 @@
B_TRANSLATE("Usage conditions download problem"),
B_TRANSLATE("An error has arisen downloading the usage "
"conditions required to create a new user.
Check the log for "
- "details and try again."));
+ "details and try again. "
+ ALERT_MSG_LOGS_USER_GUIDE));
}
return result;
diff --git a/src/apps/haikudepot/ui/UserUsageConditionsWindow.cpp
b/src/apps/haikudepot/ui/UserUsageConditionsWindow.cpp
index 62bb88d..dc7bd04 100644
--- a/src/apps/haikudepot/ui/UserUsageConditionsWindow.cpp
+++ b/src/apps/haikudepot/ui/UserUsageConditionsWindow.cpp
@@ -391,7 +391,8 @@
AppUtils::NotifySimpleError(
B_TRANSLATE("Usage conditions download problem"),
B_TRANSLATE("An error has arisen downloading the usage "
- "conditions. Check the log for details and try
again."));
+ "conditions. Check the log for details and try again. "
+ ALERT_MSG_LOGS_USER_GUIDE));
}
--
To view, visit https://review.haiku-os.org/c/haiku/+/2285
To unsubscribe, or for help writing mail filters, visit
https://review.haiku-os.org/settings
Gerrit-Project: haiku
Gerrit-Branch: master
Gerrit-Change-Id: Ib98737abe853586c58a1c1df7befb86aa1c04491
Gerrit-Change-Number: 2285
Gerrit-PatchSet: 1
Gerrit-Owner: Andrew Lindesay <apl@xxxxxxxxxxxxxx>
Gerrit-MessageType: newchange
