diff options
Diffstat (limited to 'doc/en')
-rw-r--r-- | doc/en/CMakeLists.txt | 13 | ||||
-rw-r--r-- | doc/en/Makefile.am | 6 | ||||
-rw-r--r-- | doc/en/weechat_dev.en.adoc | 1 | ||||
-rw-r--r-- | doc/en/weechat_tester.en.adoc | 131 |
4 files changed, 0 insertions, 151 deletions
diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt index 5300ffb2c..c227679eb 100644 --- a/doc/en/CMakeLists.txt +++ b/doc/en/CMakeLists.txt @@ -122,19 +122,6 @@ if(ENABLE_DOC) add_custom_target(doc-quickstart-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_quickstart.en.html) install(FILES ${CMAKE_CURRENT_BINARY_DIR}/weechat_quickstart.en.html DESTINATION ${DATAROOTDIR}/doc/${PROJECT_NAME}) - # tester's guide - add_custom_command( - OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_tester.en.html - COMMAND ${ASCIIDOCTOR_EXECUTABLE} ARGS ${ASCIIDOCTOR_ARGS} -o weechat_tester.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_tester.en.adoc - DEPENDS - ${CMAKE_CURRENT_SOURCE_DIR}/../docinfo.html - ${CMAKE_CURRENT_SOURCE_DIR}/weechat_tester.en.adoc - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} - COMMENT "Building weechat_tester.en.html" - ) - add_custom_target(doc-tester-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_tester.en.html) - install(FILES ${CMAKE_CURRENT_BINARY_DIR}/weechat_tester.en.html DESTINATION ${DATAROOTDIR}/doc/${PROJECT_NAME}) - # relay protocol add_custom_command( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_relay_protocol.en.html diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am index f94616f45..3fe34c092 100644 --- a/doc/en/Makefile.am +++ b/doc/en/Makefile.am @@ -29,7 +29,6 @@ EXTRA_DIST = CMakeLists.txt \ weechat_scripting.en.adoc \ weechat_faq.en.adoc \ weechat_quickstart.en.adoc \ - weechat_tester.en.adoc \ weechat_relay_protocol.en.adoc \ weechat_dev.en.adoc \ includes/autogen_api_completions.en.adoc \ @@ -58,7 +57,6 @@ if DOC weechat_scripting.en.html \ weechat_faq.en.html \ weechat_quickstart.en.html \ - weechat_tester.en.html \ weechat_relay_protocol.en.html \ weechat_dev.en.html doc_install = install-doc @@ -92,10 +90,6 @@ weechat_faq.en.html: weechat_faq.en.adoc $(abs_top_srcdir)/doc/docinfo.html weechat_quickstart.en.html: weechat_quickstart.en.adoc $(abs_top_srcdir)/doc/docinfo.html $(ASCIIDOCTOR) $(ASCIIDOCTOR_ARGS) -a revnumber="$(VERSION)" -o weechat_quickstart.en.html $(abs_top_srcdir)/doc/en/weechat_quickstart.en.adoc -# tester's guide -weechat_tester.en.html: weechat_tester.en.adoc $(abs_top_srcdir)/doc/docinfo.html - $(ASCIIDOCTOR) $(ASCIIDOCTOR_ARGS) -a revnumber="$(VERSION)" -o weechat_tester.en.html $(abs_top_srcdir)/doc/en/weechat_tester.en.adoc - # relay protocol weechat_relay_protocol.en.html: weechat_relay_protocol.en.adoc $(abs_top_srcdir)/doc/docinfo.html $(ASCIIDOCTOR) $(ASCIIDOCTOR_ARGS) -a revnumber="$(VERSION)" -o weechat_relay_protocol.en.html $(abs_top_srcdir)/doc/en/weechat_relay_protocol.en.adoc diff --git a/doc/en/weechat_dev.en.adoc b/doc/en/weechat_dev.en.adoc index 53617e6a7..5326a7d49 100644 --- a/doc/en/weechat_dev.en.adoc +++ b/doc/en/weechat_dev.en.adoc @@ -465,7 +465,6 @@ Documentation files: | weechat_quickstart.XX.adoc | link:weechat_quickstart.en.html[Quickstart guide]. | weechat_relay_protocol.XX.adoc | link:weechat_relay_protocol.en.html[Relay protocol] (for remote interfaces). | weechat_scripting.XX.adoc | link:weechat_scripting.en.html[Scripting guide]. -| weechat_tester.XX.adoc | link:weechat_tester.en.html[Tester's guide]. | weechat_user.XX.adoc | link:weechat_user.en.html[User's guide]. | includes/ | Files included in documentation. | autogen_api_completions.XX.adoc | Auto-generated file for Plugin API reference: completions (do *NEVER* update manually!). diff --git a/doc/en/weechat_tester.en.adoc b/doc/en/weechat_tester.en.adoc deleted file mode 100644 index 18094ff2a..000000000 --- a/doc/en/weechat_tester.en.adoc +++ /dev/null @@ -1,131 +0,0 @@ -= WeeChat tester's guide -:author: Sébastien Helleu -:email: flashcode@flashtux.org -:lang: en -:toc: left -:sectnums: -:docinfo1: - - -[[purpose]] -== Purpose - -Many thankful users ask us how can they help developing WeeChat. The -easiest (and also most tricky) way to help developing WeeChat is testing! - -Testing is a very important part of software development and should not be -underestimated. When some features are implemented it should be tested, but for -some features there are too many use cases or these cases are tricky and -developers can't try out every case. - -For example: A notorious charset plugin was introduced in WeeChat 0.2.2: none -of us (developers, contributors and testers) used channels with national -characters in their names and when 0.2.2 was released we got flooded by Russian -users blaming us. If we have more testers it should not happen again in the -future. - -Testing the stable version of WeeChat is pointless because developers are busy -implementing new stuff (and fixing old bugs) all the time. - - -[[prepare_system]] -== Prepare your system - -It would help us a lot if you enable Linux _core_ files: if WeeChat crashes, -Linux will write a file called _core_. This file contains very useful debug -info, to know exactly where is problem in WeeChat. - -If you're using the _bash_ shell, add following line to your _~/.bashrc_: - ----- -ulimit -c unlimited ----- - - -[[download]] -== Download devel version - -Fresh code (with latest bugs and features) is stored in a GIT repository. - -You may decide to build it manually (recommended way): - -* The GIT version can be built and installed in parallel to the stable version. -* You don't need root access, and you don't need to sacrifice the stable - version of WeeChat. - -[[get_sources]] -=== Get and build sources - -First create a directory, for example _weechat-git_: - ----- -$ mkdir ~/weechat-git -$ cd ~/weechat-git ----- - -If you have git installed, you can just clone the git repository (recommended -way): - ----- -$ git clone https://github.com/weechat/weechat.git -$ cd weechat ----- - -[NOTE] -Later, you can run `git pull` in this directory, to get deltas with -the latest updates. - -Otherwise you can download and unpack _devel_ package: - ----- -$ wget https://weechat.org/files/src/weechat-devel.tar.bz2 -$ tar xvjf weechat-devel.tar.bz2 -$ cd weechat-devel ----- - -To build sources, CMake is recommended: - ----- -$ mkdir build -$ cd build -$ cmake .. -DCMAKE_INSTALL_PREFIX=$HOME/weechat-git -DWEECHAT_HOME=~/.weechat-dev -DCMAKE_BUILD_TYPE=Debug -$ make -$ make install ----- - -If you don't have CMake, it's still possible to use autotools: - ----- -$ ./autogen.sh -$ ./configure --prefix=$HOME/weechat-git WEECHAT_HOME=~/.weechat-dev -$ make -$ make install ----- - -[[install_binary_package]] -=== Install binary package - -According to your Linux distribution: - -* Debian: https://weechat.org/download/debian -* Gentoo: https://weechat.org/download -* ArchLinux: PKGBUILD from https://aur.archlinux.org/ -* other: we don't know! Eheh. - - -[[run]] -== Run WeeChat - -Command is: - ----- -$ ~/weechat-git/bin/weechat ----- - -If you're still awake you should see the familiar interface and brag about -having the newest possible version of WeeChat. ;) - -Now if you experience strange behavior (it may have issues or crash or boil -your beer) don't hesitate to join _#weechat_ at _irc.libera.chat_ and tell us. - -If it doesn't crash - tell us too, we need your feedback! |