Changeset 4b53c65

Timestamp:

2011-12-19T13:39:10Z (12 years ago)

Author:

Wilmer van der Gaast <wilmer@…>

Branches:

master

Children:

f9789d4

Parents:

36533bf

Message:

Update help text for "set oauth" with what's supported now. Also adding a
"make testhelp" target to easily see if the current helpfile is loadable.

Files:

• Makefile (modified) (3 diffs)
• doc/user-guide/commands.xml (modified) (1 diff)

Makefile

@@ -27 +27 @@
 subdirobjs = $(foreach dir,$(subdirs),$(dir)/$(dir).o)
 
-all: $(OUTFILE) $(OTR_PI) $(SKYPE_PI) systemd
+all: $(OUTFILE) $(OTR_PI) $(SKYPE_PI) doc systemd
+ifdef SKYPE_PI
+        $(MAKE) -C protocols/skype doc
+endif
+
+doc:
         $(MAKE) -C doc
-ifdef SKYPE_PI
-        $(MAKE) -C protocols/skype doc
-endif
 
 uninstall: uninstall-bin uninstall-doc 
@@ -43 +45 @@
 .PHONY:   install   install-bin   install-etc   install-doc install-plugins install-systemd \
         uninstall uninstall-bin uninstall-etc uninstall-doc \
-        all clean distclean tar $(subdirs)
+        all clean distclean tar $(subdirs) doc
 
 Makefile.settings:
@@ -189 +191 @@
         @echo Hello World
 
+# Check if we can load the helpfile. (This fails if some article is >1KB.)
+# If print returns a NULL pointer, the file is unusable.
+testhelp: doc
+        gdb --eval-command='b main' --eval-command='r' \
+            --eval-command='print help_init(&global->helpfile, "doc/user-guide/help.txt")' \
+            $(OUTFILE) < /dev/null
+
 -include .depend/*.d
 # DO NOT DELETE

doc/user-guide/commands.xml

@@ -1126 +1126 @@
                 <description>
                         <para>
-                                This enables OAuth authentication for accounts that support it; right now Twitter and Google Talk (if you have 2-factor authentication enabled on your account) support it.
-                        </para>
-
-                        <para>
-                                With OAuth enabled, you shouldn't tell BitlBee your Twitter password. Just add your account with a bogus password and type <emphasis>account on</emphasis>. BitlBee will then give you a URL to authenticate with the service. If this succeeds, you will get a PIN code which you can give back to BitlBee to finish the process.
+                                This enables OAuth authentication for an IM account; right now the Twitter (working for Twitter only) and Jabber (for Google Talk, Facebook and MSN Messenger) module support it.
+                        </para>
+
+                        <para>
+                                With OAuth enabled, you shouldn't tell BitlBee your account password. Just add your account with a bogus password and type <emphasis>account on</emphasis>. BitlBee will then give you a URL to authenticate with the service. If this succeeds, you will get a PIN code which you can give back to BitlBee to finish the process.
                         </para>