[Bug 888177] New: Documentation of "_service" is not so wonderful.
https://bugzilla.novell.com/show_bug.cgi?id=888177 https://bugzilla.novell.com/show_bug.cgi?id=888177#c0 Summary: Documentation of "_service" is not so wonderful. Classification: Internal Novell Products Product: openSUSE Build Service Version: master Platform: Other OS/Version: Other Status: NEW Severity: Major Priority: P5 - None Component: source services AssignedTo: adrian@suse.com ReportedBy: osynge@suse.com QAContact: adrian@suse.com Found By: Development Blocker: No I have found very little documentation on the source service functions of OBS. http://en.opensuse.org/openSUSE:Build_Service_Concept_SourceService Being an example that should either be deprecated or at the least link to some thing more useful. The best documentation I have found is here: http://saschpe.wordpress.com/2013/11/08/obs-introducting-the-refresh_patches... I would like to see a minimum of all fields and attributes in the following "_service" file being documented. <services> <service name="tar_scm" mode="disabled"> <param name="url">git@github.com:ceph/remoto.git</param> <param name="scm">git</param> <param name="exclude">.git</param> <param name="exclude">.gitreview</param> <param name="filename">python-remoto</param> <param name="versionformat">@PARENT_TAG@</param> <param name="revision">0.0.19</param> </service> <service name="recompress" mode="disabled"> <param name="file">python-remoto*.tar</param> <param name="compression">bz2</param> </service> <service name="set_version" mode="disabled"> <param name="basename">python-remoto</param> </service> </services> The author of the code will realise that I rename the git checkout from remoto to python-remote. I searched the documentation but could not see how to do this, and resorted to asking on IRC. In an ideal world we would store what people wanted to do and link to how to do it, but I realise this is very very hard. So I propose simpler would be to do the bonus closing of this bug solution. For bonus marks in closing this bug, it would be good to get at least 3 example "_service" files, with the functions they provide and each field broken down. 1) Very basic setup such as shown above. 2) Highly automated setup doing everything and brush the dog. 3) A different highly automated system for cat lovers. These should be gathered from existing projects using this feature and each field broken down in these cases. Best regards Owen -- Configure bugmail: https://bugzilla.novell.com/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are on the CC list for the bug.
https://bugzilla.novell.com/show_bug.cgi?id=888177 https://bugzilla.novell.com/show_bug.cgi?id=888177#c1 Adrian Schröter <adrian@suse.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |RESOLVED Resolution| |FIXED --- Comment #1 from Adrian Schröter <adrian@suse.com> 2014-07-22 09:09:03 UTC --- 1) The individual services are (and have to be) documented in their package. There are the /usr/lib/obs/service/$NAME.service files inside which have to contain the documentation. Bugreports need to go to the individual service maintainers therefore. Most of them are maintained on github these day, so it might be a good idea to create issues there directly. 2) Adding src.rpms and git remote urls support got broken in osc and webui unfortunatly. Fixed this now for both in git master, so "osc add git://" and adding a git URL as remote file in webui is working again (but not yet deployed). I extended the best practice OBS docu also with an example for osc. 3) dunno what you mean here. In short, yes, we need better documentation everywhere, but time is limited (and source services were just my personal hackweek project actually. unfornatly we even had to remove the webui editor for it due to rails changes and lack of time to adapt it). I fail also to follow various wiki pages (often with wrong content), so if you want to work on improving docu please use our official docu which get a review. So misleading content should be avoided there :) http://openbuildservice.org/help/manuals/obs-reference-guide/cha.obs.source_... http://openbuildservice.org/help/manuals/obs-best-practices/cha.obs.best-pra... there is also a section describing how to work on these. -- Configure bugmail: https://bugzilla.novell.com/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are on the CC list for the bug.
participants (1)
-
bugzilla_noreply＠novell.com