Update README and fix packaging issue.
authorZhang Qiang <qiang.z.zhang@intel.com>
Tue, 14 Feb 2012 07:15:58 +0000 (15:15 +0800)
committerZhang Qiang <qiang.z.zhang@intel.com>
Tue, 14 Feb 2012 07:15:58 +0000 (15:15 +0800)
Makefile
README.rst
distfiles/gbs.spec

index dd2b859..0ad2c0d 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -21,7 +21,7 @@ tag:
 dist-common: man
        git archive --format=tar --prefix=$(PKGNAME)-$(TAGVER)/ $(TAG) | tar xpf -
        git show $(TAG) --oneline | head -1 > $(PKGNAME)-$(TAGVER)/commit-id
-       mkdir $(PKGNAME)-$(TAGVER)/doc; mv mic.1 $(PKGNAME)-$(TAGVER)/doc
+       mkdir $(PKGNAME)-$(TAGVER)/doc; mv gbs.1 $(PKGNAME)-$(TAGVER)/doc
 
 dist-bz2: dist-common
        tar jcpf $(PKGNAME)-$(TAGVER).tar.bz2 $(PKGNAME)-$(TAGVER)
@@ -32,7 +32,7 @@ dist-gz: dist-common
        rm -rf $(PKGNAME)-$(TAGVER)
 
 man: README.rst
-       rst2man $< >mic.1
+       rst2man $< >gbs.1
 
 install: all
        python setup.py install --prefix=${PREFIX}
index 233d521..95d43be 100644 (file)
@@ -25,6 +25,9 @@ It supports native running in many mainstream Linux distributions, including:
 
 Installation
 ============
+gbs is recommended to install from official repository, but if your system have
+not been supported by official repo, you can try to install gbs from source 
+code, before that, you should install gbs's dependencies such as git, osc. 
 
 Repositories
 ------------
@@ -114,6 +117,21 @@ Ubuntu/Debian Installation
 
 Source Installation
 -------------------
+If you need install gbs from source code, you need install gbs's dependencies
+first, required packages as follows:
+
+* git-core
+* osc >= 0.131
+* rpm (None Fedora)
+* rpm-build (Fedora)
+
+Official osc are maintained at:
+
+ `<http://download.opensuse.org/repositories/openSUSE:/Tools/>`_
+
+which can be added to you system, then using general package manager tools
+to install osc. 
+
 Gbs source code is managed by Gerrit in tizen staging zone(temporarily), you
 need an account to access it.
 
@@ -134,9 +152,9 @@ Then using the following commands to install gbs:
 
 Configuration file
 ==================
-At the first time to run the gbs, it will prompt you to input your user_name
-and password. Or edit the configuration file by yourself.  Just make sure it
-looks like as below:
+gbs read gbs configure file from ~/.gbs.conf. At the first time to run the gbs,
+it will prompt you to input your user_name and password. Or edit the 
+configuration file by yourself.  Just make sure it looks like as below:
 ::
 
   [general]
@@ -146,6 +164,7 @@ looks like as below:
   ; settings for build subcommand
   build_server = <OBS API URL>
   user = <USER_NAME>
+  passwd  = <PASSWORD in base64 string>
   passwdx = <PASSWORD encoded in base64 string>
 
 In this configuration file, there are two sections: [common] is for general
@@ -154,11 +173,14 @@ setting, and [build] is for the options of gbs build.
 In the [build] section, the following values can be specified:
 
 build_server
-    OBS API url, which point to remote OBS.
+    OBS API url, which point to remote OBS. Available value can be:
+    https://api.stg.tizen.org
 user
     OBS account user name
+passwd
+    raw OBS account user passwd
 passwdx
-    encoded OBS account user passwd
+    encoded OBS account user passwd, this key would be generated automaticlly.
 
 Usages
 ======
@@ -169,7 +191,7 @@ Running 'gbs build'
 --------------------
 
 Subcommand `build` is used to push local git code to remote obs build server
-to build. The usage of subcommand `build` can be avaliable using `gbs build --help`
+to build. The usage of subcommand `build` can be available using `gbs build --help`
 ::
 
   build (bl): test building for current pkg
index dd3b2bf..7d532b0 100644 (file)
@@ -43,7 +43,7 @@ rm -rf $RPM_BUILD_ROOT
 %endif
 
 mkdir -p %{buildroot}/%{_prefix}/share/man/man1
-install -m644 doc/mic.1 %{buildroot}/%{_prefix}/share/man/man1
+install -m644 doc/gbs.1 %{buildroot}/%{_prefix}/share/man/man1
 
 %files
 %defattr(-,root,root,-)