# # # add_file "README.driver" # content [c18ae3d9ee331e21fc63c1562255660a9cd9f183] # # patch "NEWS" # from [04de641e835a61c6ac2232e669023574d806fdb8] # to [5eff9764cab7ac88c623822e4c919c3d1628a9a8] # # patch "notes/IDEAS" # from [07e7547e38a00261b471c2e472e81876506d7efc] # to [3cd3f1f628b8cc9e9f55bf306dc08dad867e2e09] # ============================================================ --- README.driver c18ae3d9ee331e21fc63c1562255660a9cd9f183 +++ README.driver c18ae3d9ee331e21fc63c1562255660a9cd9f183 @@ -0,0 +1,55 @@ + +Introduction +============ + +This document describes the calling interface ("driver") to guitone which can +be used to script guitone's dialog system. + +The general calling convention is the following: + + $ exec [] + +where + + is the path to the guitone binary (on Mac OS X the binary inside + the application bundle, in guitone.app/Contents/MacOS) + + is the database file or workspace path you want guitone operate + on (use "-" to denote that you want to call a dialog without a + database / workspace affinity, f.e. the preferences dialog) + + is the name of the function you like to call (see below) + + are optional arguments to this function + +There is a calling hierarchy which makes it possible to call all dialogs without +path affinity from a call with database affinity and likewise all dialogs with +database affinity from a call with workspace affinity. So the following three +calls lead to the same results, i.e. the preferences dialog is displayed, +(though for the latter two the given database file or workspace path must be +valid): + + $ guitone exec - showPreferences + $ guitone exec database.mtn showPreferences + $ guitone exec ~/workspace showPreferences + + +Function Reference +================== + +TODO, please check the sources, particularily + + src/view/dialogs/(Database|Workspace|)DialogManager.h + +for a list of callable public slots in the meantime. + + +Known Bugs +========== + +* Please note that there is currently no way of getting data from these calls in + a defined way. If you need such a thing, drop me a mail and I'm sure we find + a solution. + +* Currently calling functions with arguments leads to unexpected behaviour or + even crashes. I'm still investigating the issue. ============================================================ --- NEWS 04de641e835a61c6ac2232e669023574d806fdb8 +++ NEWS 5eff9764cab7ac88c623822e4c919c3d1628a9a8 @@ -1,6 +1,11 @@ ????-??-?? (0.8) - starting from this version (0.8) guitone is distributed under the terms of the GNU General Public License Version 3 + - new: possibility to call single dialogs (i.e. commit, file history, etc.) + from the command line without a running main window which should be useful + for all kinds of operating systems integration (a TortoiseMTN version is + already been developed by Christof Petig); please check README.driver for + more information about this interface - new: its now possible to restrict commits to certain files and / or directories - just right-click one or more entries in your workspace and hit "commit" @@ -18,6 +23,7 @@ dialog. (closes FS#10) - new: an installer for win32 which takes care of needed libraries and proper uninstallation + - new: colors for diff views can now be configured in the preferences - improved: startup dialog slightly changed - now contains the possibility to edit the preferences, open recent databases and workspaces. Removed this functionality from the initialization phase of the application which was ============================================================ --- notes/IDEAS 07e7547e38a00261b471c2e472e81876506d7efc +++ notes/IDEAS 3cd3f1f628b8cc9e9f55bf306dc08dad867e2e09 @@ -12,7 +12,7 @@ the TODO file: restricted to a path which is invalid in either revision, or if we're trying to get_file a file which does not exist in either one... stuff like that. -* TortoiseSVN-alike completion of file/function names in the commit dialog +* TortoiseSVN-alike completion of function names in the commit dialog * make changed items view configurable (currently they're just bold) * integrate support to make guitone a kpart module under KDE * add functionality which is currently missing from monotone (update, ...) @@ -21,8 +21,6 @@ the TODO file: * add unit tests for all the internals * make file-saving rollback'able if aborted / on error * implement drag'n'drop and proper rename support (stubs) -* make coloring throughout the application configurable, find saner defaults - for the currently redish/greenish diff output * make more use of typedefs to define more clearly what kind of parameters a certain method accepts. If everything is just labeled as QString this won't help the code readability a lot... @@ -36,5 +34,4 @@ the TODO file: abort / restart single threads * test and optionally download / install a known working version of monotone inside the windows installer -* provide auto-completion in the textbox of the commit dialog to aid typing changelog messages