[kde-doc-english] Searching for V4.2 in docbooks of KF5 trunk
> grep 'V4\.2' trunkkf5/documentation/*/*/*.docbook trunkkf5/documentation/extragear-network/konversation/index.docbook:
[kde-doc-english] [kdepim] doc/akonadi_followupreminder_agent: Switch to 4.5 based docbooks
Git commit f349c2793275a4064030812b172326b22ffc542d by Albert Astals Cid. Committed on 18/08/2014 at 18:19. Pushed by aacid into branch 'master'. Switch to 4.5 based docbooks M +2-2doc/akonadi_followupreminder_agent/index.docbook http://commits.kde.org/kdepim/f349c2793275a4064030812b172326b22ffc542d diff --git a/doc/akonadi_followupreminder_agent/index.docbook b/doc/akonadi_followupreminder_agent/index.docbook index 1c3a203..051738f 100644 --- a/doc/akonadi_followupreminder_agent/index.docbook +++ b/doc/akonadi_followupreminder_agent/index.docbook @@ -1,6 +1,6 @@ -Follow Up Reminder Agent">
[kde-doc-english] [kdepimlibs] kioslave/docs: Switch to 4.5 based docbooks
Git commit 370c74d0668ea3875ec8cbef4da421f2b81beef7 by Albert Astals Cid. Committed on 18/08/2014 at 18:13. Pushed by aacid into branch 'master'. Switch to 4.5 based docbooks M +2-2kioslave/docs/imap/index.docbook M +2-2kioslave/docs/ldap/index.docbook M +2-2kioslave/docs/mbox/index.docbook M +2-2kioslave/docs/nntp/index.docbook M +2-2kioslave/docs/pop3/index.docbook M +2-2kioslave/docs/sieve/index.docbook M +2-2kioslave/docs/smtp/index.docbook http://commits.kde.org/kdepimlibs/370c74d0668ea3875ec8cbef4da421f2b81beef7 diff --git a/kioslave/docs/imap/index.docbook b/kioslave/docs/imap/index.docbook index 909e4eb..94fe6d2 100644 --- a/kioslave/docs/imap/index.docbook +++ b/kioslave/docs/imap/index.docbook @@ -1,6 +1,6 @@ - ]> diff --git a/kioslave/docs/ldap/index.docbook b/kioslave/docs/ldap/index.docbook index 205e8e3..b81cb3a 100644 --- a/kioslave/docs/ldap/index.docbook +++ b/kioslave/docs/ldap/index.docbook @@ -1,6 +1,6 @@ - ]> diff --git a/kioslave/docs/mbox/index.docbook b/kioslave/docs/mbox/index.docbook index b96c964..b50f6f8 100644 --- a/kioslave/docs/mbox/index.docbook +++ b/kioslave/docs/mbox/index.docbook @@ -1,6 +1,6 @@ - ]> diff --git a/kioslave/docs/nntp/index.docbook b/kioslave/docs/nntp/index.docbook index dc5de4a..84cbb21 100644 --- a/kioslave/docs/nntp/index.docbook +++ b/kioslave/docs/nntp/index.docbook @@ -1,6 +1,6 @@ - ]> diff --git a/kioslave/docs/pop3/index.docbook b/kioslave/docs/pop3/index.docbook index 1eb4674..f74bb7b 100644 --- a/kioslave/docs/pop3/index.docbook +++ b/kioslave/docs/pop3/index.docbook @@ -1,6 +1,6 @@ - ]> diff --git a/kioslave/docs/sieve/index.docbook b/kioslave/docs/sieve/index.docbook index 1987d1c..e9458e2 100644 --- a/kioslave/docs/sieve/index.docbook +++ b/kioslave/docs/sieve/index.docbook @@ -1,6 +1,6 @@ - ]> diff --git a/kioslave/docs/smtp/index.docbook b/kioslave/docs/smtp/index.docbook index b0cdef4..6416703 100644 --- a/kioslave/docs/smtp/index.docbook +++ b/kioslave/docs/smtp/index.docbook @@ -1,6 +1,6 @@ - ]>
[kde-doc-english] [kcachegrind/frameworks] doc: Update to new DTD for documentation.
Git commit fde081f8bea8433a1dc47c5f1543918d031e321f by Arnold Dumas. Committed on 18/08/2014 at 14:01. Pushed by arnolddumas into branch 'frameworks'. Update to new DTD for documentation. M +1-1doc/index.docbook http://commits.kde.org/kcachegrind/fde081f8bea8433a1dc47c5f1543918d031e321f diff --git a/doc/index.docbook b/doc/index.docbook index 60ef874..fef6849 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1,5 +1,5 @@ -KCachegrind'> Cachegrind"> Calltree">
[kde-doc-english] Documenting Commandline Applications
On Sunday 17 August 2014 07:57 PM, Yuri Chornoivan wrote: > Sun, 17 Aug 2014 17:23:54 +0300, Bhaskar Kandiyal > : > >> Just wondering if I can get the documentation that I wrote for my >> project reviewed by anyone? >> Is there a review group that I can add to my review request [1]? >> >> Cheers, >> Bhaskar Kandiyal >> >> [1] - https://git.reviewboard.kde.org/r/119811/ > > Hi, > > Just add "docs" as a Reviewers group. > > Best regards, > Yuri > Many thanks Yuri for taking the time to review the documentation, much appreciated! :) Cheers, Bhaskar Kandiyal
[kde-doc-english] Review Request 119811: Migrate RST documentation to DocBook
--- This is an automatically generated e-mail. To reply, visit: https://git.reviewboard.kde.org/r/119811/ --- (Updated Aug. 18, 2014, 7:01 a.m.) Status -- This change has been marked as submitted. Review request for Documentation, Kevin Krammer and Jonathan Marten. Repository: akonadiclient Description --- I contacted the KDE documentation team and they said that all documentation is in docbook format (even man pages). They pointed me in the right direction and I found a template for writing man pages in KDocUtils. I guess I should have looked up the standard way of documentation in KDE first. This patch removes the old RST documentation and uses the DocBook format. Diffs - doc/akonadiclient.1.rst bef495e doc/man-akonadiclient.1.docbook PRE-CREATION doc/CMakeLists.txt f28ff08 Diff: https://git.reviewboard.kde.org/r/119811/diff/ Testing --- Did manual testing and observed intended behaviour. Thanks, Bhaskar Kandiyal -- next part -- An HTML attachment was scrubbed... URL: <http://mail.kde.org/pipermail/kde-doc-english/attachments/20140818/bc090df2/attachment.html>
[kde-doc-english] [akonadiclient] doc: Migrate RST documentation to DocBook
Git commit fed08467f29f15f88fb6e4791eb88d0f5febd374 by Bhaskar Kandiyal.
Committed on 18/08/2014 at 07:00.
Pushed by bkandiyal into branch 'master'.
Migrate RST documentation to DocBook
REVIEW: 119811
M +1-18 doc/CMakeLists.txt
D +0-285 doc/akonadiclient.1.rst
A +412 -0doc/man-akonadiclient.1.docbook
http://commits.kde.org/akonadiclient/fed08467f29f15f88fb6e4791eb88d0f5febd374
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index f28ff08..c8183c8 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -1,18 +1 @@
-set(AKONADICLIENTDOC_MANS
- akonadiclient.1
-)
-
-find_program(RST2MAN_EXECUTABLE NAMES rst2man)
-find_program(GZIP_EXECUTABLE NAMES gzip)
-
-foreach(manpage ${AKONADICLIENTDOC_MANS})
- execute_process(COMMAND ${RST2MAN_EXECUTABLE}
- ${CMAKE_CURRENT_SOURCE_DIR}/${manpage}.rst
- ${CMAKE_CURRENT_BINARY_DIR}/${manpage}
- )
-
- execute_process(COMMAND ${GZIP_EXECUTABLE} -f
${CMAKE_CURRENT_BINARY_DIR}/${manpage})
-
-endforeach()
-
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/akonadiclient.1.gz DESTINATION
${MAN_INSTALL_DIR}/man1/)
+kde4_create_manpage(man-akonadiclient.1.docbook 1 INSTALL_DESTINATION
${MAN_INSTALL_DIR})
diff --git a/doc/akonadiclient.1.rst b/doc/akonadiclient.1.rst
deleted file mode 100644
index bef495e..000
--- a/doc/akonadiclient.1.rst
+++ /dev/null
@@ -1,285 +0,0 @@
-==
-akonadiclient
-==
-
-A commandline client for Akonadi
-
-
-:Author: Bhaskar Kandiyal
-:Date: August 12 2014
-:Copyright: Copyright (C) 2014 Bhaskar Kandiyal. Free use of this software is
granted under the terms of the GNU General Public License version 2 or any
later version.
-:Version: 0.1
-:Manual section: 1
-
-SYNOPSIS
-
-**akonadiclient** command [options] [arguments]
-
-DESCRIPTION
-===
-**akonadiclient** is a commandline client for manipulating KDE's Akonadi
datastore. It provides an easy way to manipulate Akonadi's data through the
commandline.
-For example, adding items, collections, renaming or moving collections and
also controlling the Akonadi agents.
-
-COMMANDS
-
-
-Filesystem Commands
-
-**copy**
-
-akonadiclient copy [OPTIONS] SOURCE DESTINATION
-
-Used to copy collections or items from one collection to another.
-
-Options:
-
-
-**-n, --dryrun**
-
-Run without making any actual changes
-
-**create**
-
-akonadiclient create OPTIONS COLLECTION
-
-Creates a new collection. Please note that top-level collections can only
be created by an Akonadi resource.
-
-Options:
-
-**-p, --parent **
-
-Parent collection to create the new collection in.
-
-**-n, --dryrun**
-
-Run without making any actual changes
-
-**delete**
-
-akonadiclient delete [OPTIONS] COLLECTION | ITEM
-
-Delete a collection or an item.
-
-Options:
-
-**-c, --collection**
-
-Assume that a collection is specified as an argument
-
-**-i, --item**
-
-Assume that an item is specified as an argument
-
-**-n, --dryrun**
-
-Run without making any actual changes
-
-**list**
-
-akonadiclient list [OPTIONS] COLLECTION
-
-List sub-collections and / or items inside the collection specified by
COLLECTION.
-
-Options:
-
-**-l, --details**
-
-List more detailed information
-
-**-c, --collections**
-
-List only sub-collections
-
-**-i, --items**
-
-List only contained items
-
-**move**
-
-akonadiclient move [OPTIONS] SOURCE DESTINATION
-
-Move collections or items into another collection
-
-Options:
-
-**-n, --dryrun**
-
-Run without making any actual changes
-
-**rename**
-
-akonadiclient rename [OPTIONS] COLLECTION NAME
-
-Renames a the specified collection to NAME
-
-Options:
-
-**-n, --dryrun**
-
-Run without making any actual changes
-
-Data Commands
--
-
-**add**
-
-akonadiclient add [OPTIONS] COLLECTION FILES
-
-Add items to a specified collection
-
-
-Options:
-
-**-b, --base **
-
-Base directory for input files / directories, default is current
-
-**-f, --flat**
-
-Flat mode, do not duplicate subdirectory structure
-
-**-n, --dryrun**
-
-Run without making any actual changes
-
-
-**edit**
-
-
-akonadiclient edit [OPTIONS] ITEM
-
-Opens up the payload of ITEM in a text editor specified by the environment
variable $EDITOR
-
-Options:
-
-**-n, --dryrun**
-
-Run without making any actual changes
-
-**expand**
-
-
-akonadiclient expand [OPTIONS] ITEM
-
-Expand a contact group item
-
-Options:
-
-**-b, --brief**
-
-Brief output (email addresses only)
-
-**export**
-
-
-akonadiclient export [OPTIONS] COLLECTION FILE
-
-Exports COLLECTION to an XML file specified by FILE
-
-Options:
-
-**-n, --dryrun**
-
