summaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/bugs/fails_to_build_against_current_LTS_Haskell.mdwn2
-rw-r--r--doc/bugs/fails_to_build_against_current_LTS_Haskell/comment_1_a65679d04d33e0037d15f0a47f313aeb._comment10
-rw-r--r--doc/bugs/master_fails_to_build.mdwn32
-rw-r--r--doc/faq.mdwn4
-rw-r--r--doc/forum.mdwn4
-rw-r--r--doc/index.mdwn6
-rw-r--r--doc/news/version_1.20170810.mdwn4
-rw-r--r--doc/todo/command_review_mode.mdwn3
8 files changed, 62 insertions, 3 deletions
diff --git a/doc/bugs/fails_to_build_against_current_LTS_Haskell.mdwn b/doc/bugs/fails_to_build_against_current_LTS_Haskell.mdwn
index 52b9faf..2d1c0aa 100644
--- a/doc/bugs/fails_to_build_against_current_LTS_Haskell.mdwn
+++ b/doc/bugs/fails_to_build_against_current_LTS_Haskell.mdwn
@@ -13,3 +13,5 @@ debug-me fails to build against LTS 8.23:
make[2]: *** [debug-me] Error 1
--spwhitton
+
+> [[fixed|done]] --[[Joey]]
diff --git a/doc/bugs/fails_to_build_against_current_LTS_Haskell/comment_1_a65679d04d33e0037d15f0a47f313aeb._comment b/doc/bugs/fails_to_build_against_current_LTS_Haskell/comment_1_a65679d04d33e0037d15f0a47f313aeb._comment
new file mode 100644
index 0000000..6206213
--- /dev/null
+++ b/doc/bugs/fails_to_build_against_current_LTS_Haskell/comment_1_a65679d04d33e0037d15f0a47f313aeb._comment
@@ -0,0 +1,10 @@
+[[!comment format=mdwn
+ username="spwhitton"
+ avatar="http://cdn.libravatar.org/avatar/9c3f08f80e67733fd506c353239569eb"
+ subject="comment 1"
+ date="2018-12-05T04:41:07Z"
+ content="""
+Debian has moved onto LTS 12.10 and debug-me requires haskell-aeson older than 1.3.
+
+Unless debug-me is updated, it will unfortunately not be included in Debian buster, which would scupper plans for a debug-me.debian.org.
+"""]]
diff --git a/doc/bugs/master_fails_to_build.mdwn b/doc/bugs/master_fails_to_build.mdwn
new file mode 100644
index 0000000..1571c16
--- /dev/null
+++ b/doc/bugs/master_fails_to_build.mdwn
@@ -0,0 +1,32 @@
+```
+Downloading lts-9.0 build plan ...
+Downloaded lts-9.0 build plan.
+Updating package index Hackage (mirrored at https://s3.amazonaws.com/hackage.fpcomplete.com/) ...
+Selected mirror https://s3.amazonaws.com/hackage.fpcomplete.com/
+Downloading root
+Selected mirror https://s3.amazonaws.com/hackage.fpcomplete.com/
+Downloading timestamp
+Downloading snapshot
+Downloading mirrors
+Cannot update index (no local copy)
+Downloading index
+Updated package list downloaded
+Populating index cache ...
+Populated index cache.
+
+Error: While constructing the build plan, the following exceptions were encountered:
+
+In the dependencies for debug-me-1.20170810:
+ posix-pty must match (>=0.2.1), but the stack configuration has no specified version (latest applicable is 0.2.1.1)
+needed since debug-me-1.20170810 is a build target.
+
+Recommended action: try adding the following to your extra-deps in /builddir/debug-me-1.20170810/stack.yaml:
+- posix-pty-0.2.1.1
+
+You may also want to try the 'stack solver' command
+Plan construction failed.
+```
+
+I couldn't see posix-pty in the lts package list? Was it erroneously removed from stack.yaml?
+
+> posix-pty is in stack.yaml since last year, so [[done]] --[[Joey]]
diff --git a/doc/faq.mdwn b/doc/faq.mdwn
index 10d6422..f559d87 100644
--- a/doc/faq.mdwn
+++ b/doc/faq.mdwn
@@ -24,8 +24,8 @@ also put keyrings in that directory, and then debug-me will be able to
tell then a developer of a project is connecting.
If debug-me says that "John Doe is probably a real person", it means
-that he's connected to the strong set of the GnuPG web of trust.
-Other people, who certianly are real, have verified his identity.
+that he's connected to the strong set of the GnuPG web of trust. That
+means: Other people, who certianly are real, have verified his identity.
So even if you don't know his name, it can be safe to let him connect,
but if in doubt, don't let him.
diff --git a/doc/forum.mdwn b/doc/forum.mdwn
new file mode 100644
index 0000000..732c4bb
--- /dev/null
+++ b/doc/forum.mdwn
@@ -0,0 +1,4 @@
+This is a place to discuss using debug-me, share tips and tricks, etc.
+If you need help, advice, or anything, post about it here.
+
+[[!inline pages="forum/* and !*/Discussion" archive=yes rootpage=forum postformtext="Add a new thread titled:"]]
diff --git a/doc/index.mdwn b/doc/index.mdwn
index 14fec93..7ea627d 100644
--- a/doc/index.mdwn
+++ b/doc/index.mdwn
@@ -4,6 +4,7 @@
* [[News]]
* [[Bugs]]
* [[Todo]]
+* [[Forum]]
* [[Protocol]]
* [[Evidence]]
* [[Servers]]
@@ -15,7 +16,10 @@ Debugging a problem over email/irc/BTS is slow, tedious, and hard. The
developer needs to see the your problem to understand it. Debug-me aims to
make debugging fast, fun, and easy, by letting the developer access your
computer remotely, so they can immediately see and interact with the
-problem. Making your problem their problem gets it fixed fast.
+problem. Making your problem their problem gets it fixed fast. As
+Simon Tatham [[puts it|https://www.chiark.greenend.org.uk/~sgtatham/bugs.html]],
+"In a nutshell, the aim of a bug report is to enable the programmer to see the
+program failing in front of them." debug-me does just that!
A debug-me session is logged and signed with the developer's GnuPG key,
producing a [[chain of evidence|evidence]] of what they saw and what they
diff --git a/doc/news/version_1.20170810.mdwn b/doc/news/version_1.20170810.mdwn
new file mode 100644
index 0000000..3597a23
--- /dev/null
+++ b/doc/news/version_1.20170810.mdwn
@@ -0,0 +1,4 @@
+debug-me 1.20170810 released with [[!toggle text="these changes"]]
+[[!toggleable text="""
+ * Fix build with websockets-0.10.0.0 which did not support compression.
+ * Update to lts-9.0."""]] \ No newline at end of file
diff --git a/doc/todo/command_review_mode.mdwn b/doc/todo/command_review_mode.mdwn
new file mode 100644
index 0000000..6ff8d60
--- /dev/null
+++ b/doc/todo/command_review_mode.mdwn
@@ -0,0 +1,3 @@
+It would be nice to have a command review mode where the owner of the debugged computer would have to review and approve each command submitted by the debugger.
+
+This would be useful for slightly more technical or paranoid folks who would like more control over the debug session than just post-facto reputation degradation.