kallithea Changeset - 1a498b11f154

Changeset - 1a498b11f154

Parent rev.

Child rev.

[Not reviewed]

rhodecode-0.0.1.5.3 default

0 7 0

Marcin Kuzminski - 13 years ago 2013-02-12 22:42:26
marcin@python-works.com

Docs updates

7 files changed with 116 insertions and 16 deletions:

README.rst

docs/changelog.rst

docs/installation_win.rst

docs/setup.rst

docs/upgrade.rst

docs/usage/general.rst

docs/usage/troubleshooting.rst

0 comments (0 inline, 0 general)

README.rst

➞

Show inline comments

@@ @@ -6,7 +6,7 @@ About @@
 -----
 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_
-with a built in push/pull server and full text search and code-review.
+with a built in push/pull server, full text search and code-review.
 It works on http/https and has a built in permission/authentication system with
 the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides
 simple API so it's easy integrable with existing external systems.
@@ @@ -176,4 +176,4 @@ have sphinx_ installed you can install i @@
 .. _git: http://git-scm.com/
 .. _celery: http://celeryproject.org/
 .. _Sphinx: http://sphinx.pocoo.org/
 .. _vcs: http://pypi.python.org/pypi/vcs
@@ \ No newline at end of file @@
 .. _vcs: http://pypi.python.org/pypi/vcs

docs/changelog.rst

➞

Show inline comments

@@ @@ -4,6 +4,26 @@ @@
 Changelog
 =========
 .5.3 (**2013-02-12**)
 ----------------------
 news
 ++++
 - IP restrictions now also enabled for IPv6
 fixes
 +++++
 - fixed issues with private checkbox not always working
 - fixed #746 unicodeDedode errors on feed controllers
 - fixes issue #756 cleanup repos didn't properly compose paths of repos to be cleaned up.
 - fixed cache invalidation issues together with vcs_full_cache option
 - repo scan should skip directories with starting with '.'
 - fixes for issue #731, update-repoinfo sometimes failed to update data when changesets
   were initial commits
 - recursive mode of setting permission skips private repositories
 .5.2 (**2013-01-14**)
 ----------------------
@@ @@ -932,4 +952,4 @@ fixes @@
 - Disabled dirsize in file browser, it's causing nasty bug when dir renames
   occure. After vcs is fixed it'll be put back again.
 - templating/css rewrites, optimized css.
@@ \ No newline at end of file @@
 - templating/css rewrites, optimized css.

docs/installation_win.rst

➞

Show inline comments

@@ @@ -13,8 +13,13 @@ Target OS: Windows XP SP3 32bit English @@
 .. note::
    This installation is for 32bit systems, for 64bit windows you might need
    to download proper 64bit version of "Windows Installer" and Win32py
    extensions
    to download proper 64bit versions of the different packages(Windows Installer, Win32py extensions)
    plus some extra tweaks.
    These extra steps haven been marked as "64bit".
    Tested on Windows Server 2008 R2 SP1, 9-feb-2013.
    If you run into any 64bit related problems, please check these pages:
    - http://blog.victorjabur.com/2011/06/05/compiling-python-2-7-modules-on-windows-32-and-64-using-msvc-2008-express/
    - http://bugs.python.org/issue7511
 Step1 - Install Visual Studio 2008 Express
 ------------------------------------------
@@ @@ -31,12 +36,27 @@ You can also download full ISO file for @@
 choose "All - Offline Install ISO image file" in the previous page and
 choose "Visual C++ 2008 Express" when installing.
 .. note::
    Using other versions of Visual Studio will lead to random crashes.
    You must use Visual Studio 2008!"
 .. note::
   Silverlight Runtime and SQL Server 2008 Express Edition are not
   required, you can uncheck them
 .. note::
 bit: You also need to install the Microsoft Windows SDK for .NET 3.5 SP1 (.NET 4.0 won't work).
    Download from: http://www.microsoft.com/en-us/download/details.aspx?id=3138
 .. note::
 bit: You also need to copy and rename a .bat file to make the Visual C++ compiler work.
    I am not sure why this is not necessary for 32bit.
    Copy C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\vcvars64.bat to C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\amd64\vcvarsamd64.bat
 Step2 - Install Python
 ----------------------
@@ @@ -50,6 +70,9 @@ Installer". While writing this guide, th @@
 Remember the specific major and minor version installed, because it will
 be needed in the next step. In this case, it is "2.7".
 .. note::
 bit: Just download and install the 64bit version of python.
 Step3 - Install Win32py extensions
 ----------------------------------
@@ @@ -64,6 +87,11 @@ http://sourceforge.net/projects/pywin32/ @@
   When writing this guide, the file was:
   http://sourceforge.net/projects/pywin32/files/pywin32/Build%20217/pywin32-217.win32-py2.7.exe/download
   .. note::
 bit: Download and install the 64bit version.
      At the time of writing you can find this at:
      http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/pywin32-218.win-amd64-py2.7.exe/download
 Step4 - Python BIN
 ------------------
@@ @@ -142,6 +170,20 @@ Command Prompt (**IMPORTANT!!**). To do @@
 "Microsoft Visual C++ 2008 Express Edition" -> "Visual Studio Tools" ->
 "Visual Studio 2008 Command Prompt"
 .. note::
 bit: For 64bit you need to modify the shortcut that is used to start the
    Visual Studio 2008 Command Prompt. Use right-mouse click to open properties.
 Change commandline from::
 %comspec% /k ""C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"" x86
 to::
 %comspec% /k ""C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"" amd64
 In that CMD (loaded with VS2008 PATHs) type::
   cd C:\RhodeCode\Env\Scripts (or similar)
@@ @@ -247,4 +289,4 @@ Open a CommandPrompt like in Step7 (VS20 @@
  paster upgrade-db production.ini (update database)
 Full steps in http://packages.python.org/RhodeCode/upgrade.html
@@ \ No newline at end of file @@
 Full steps in http://packages.python.org/RhodeCode/upgrade.html

docs/setup.rst

➞

Show inline comments

@@ @@ -528,11 +528,21 @@ Sample config for nginx using proxy:: @@
+    }
     server {
        listen          80;
        server_name     hg.myserver.com;
        listen          443;
        server_name     rhodecode.myserver.com;
        access_log      /var/log/nginx/rhodecode.access.log;
        error_log       /var/log/nginx/rhodecode.error.log;
        ssl on;
        ssl_certificate     rhodecode.myserver.com.crt;
        ssl_certificate_key rhodecode.myserver.com.key;
        ssl_session_timeout 5m;
        ssl_protocols SSLv3 TLSv1;
        ssl_ciphers DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:EDH-RSA-DES-CBC3-SHA:AES256-SHA:DES-CBC3-SHA:AES128-SHA:RC4-SHA:RC4-MD5;
        ssl_prefer_server_ciphers on;
        # uncomment if you have nginx with chunking module compiled
        # fixes the issues of having to put postBuffer data for large git
        # pushes
@@ @@ -679,8 +689,8 @@ Here is a sample excerpt from an Apache @@
    into above configuration
 .. note::
    RhodeCode cannot be runned in multiprocess mode in apache, make sure
    you don't specify `processes=num` directive in the config
    Running RhodeCode in multiprocess mode in apache is not supported,
    make sure you don't specify `processes=num` directive in the config
 Example wsgi dispatch script::
@@ @@ -722,4 +732,4 @@ Some example init.d scripts can be found @@
 .. _mercurial-server: http://www.lshift.net/mercurial-server.html
 .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories
 .. _Issues tracker: https://bitbucket.org/marcinkuzminski/rhodecode/issues
 .. _google group rhodecode: http://groups.google.com/group/rhodecode
@@ \ No newline at end of file @@
 .. _google group rhodecode: http://groups.google.com/group/rhodecode

docs/upgrade.rst

➞

Show inline comments

@@ @@ -75,6 +75,14 @@ This will upgrade the schema and update @@
 and will always recheck the settings of the application, if there are no new
 options that need to be set.
 .. note::
    DB schema upgrade library has some limitations and can sometimes fail if you try to
    upgrade from older major releases. In such case simply run upgrades sequentially, eg.
    upgrading from 1.2.X to 1.5.X should be done like that: 1.2.X. > 1.3.X > 1.4.X > 1.5.X
    You can always specify what version of RhodeCode you want to install for example in pip
    `pip install RhodeCode==1.3.6`
 You may find it helpful to clear out your log file so that new errors are
 readily apparent::

docs/usage/general.rst

➞

Show inline comments

@@ @@ -13,7 +13,15 @@ delete a repository from filesystem, it @@
 not possible to push,clone or access repository. It's worth a notice that,
 even if someone will be given administrative access to RhodeCode and will
 delete a repository You can easy restore such action by restoring `rm__<date>`
 from the repository name, and internal repository storage (.hg/.git)
 from the repository name, and internal repository storage (.hg/.git). There
 is also a special command for cleaning such archived repos::
     paster cleanup-repos --older-than=30d production.ini
 This command will scan for archived repositories that are older than 30d,
 display them and ask if you want to delete them (there's a --dont-ask flag also)
 If you host big amount of repositories with forks that are constantly deleted
 it's recommended that you run such command via crontab.
 Follow current branch in file view
 ----------------------------------
@@ @@ -31,7 +39,7 @@ Checkboxes in compare view allow users t @@
 only show the range between the first and last checkbox (no cherry pick).
 Clicking more than one checkbox will activate a link in top saying
 `Show selected changes <from-rev> -> <to-rev>` clicking this will bring
 compare view
+compare view. In this view also it's possible to switch to combined compare.
 Compare view is also available from the journal on pushes having more than
 one changeset
@@ @@ -97,11 +105,11 @@ Currently it support following options: @@
 .. note::
-    - *`svn -> hg` cloning requires `hgsubversion` library to be installed.*
+    * `svn -> hg` cloning requires `hgsubversion` library to be installed.*
 If you need to clone repositories that are protected via basic auth, you
 might pass the url with stored credentials inside eg.
 `http://user:passw@remote.server/repo, RhodeCode will try to login and clone
+`http://user:passw@remote.server/repo`, RhodeCode will try to login and clone
 using given credentials. Please take a note that they will be stored as
 plaintext inside the database. RhodeCode will remove auth info when showing the
 clone url in summary page.

docs/usage/troubleshooting.rst

➞

Show inline comments

@@ @@ -55,6 +55,18 @@ Troubleshooting @@
 :Q: **RhodeCode is slow for me, how can i make it faster?**
 :A: See the :ref:`performance` section
+|
 :Q: **UnicodeDecodeError on Apache mod_wsgi**
 :A: Please read: https://docs.djangoproject.com/en/dev/howto/deployment/wsgi/modwsgi/#if-you-get-a-unicodeencodeerror
+|
 :Q: **Requests hanging on Windows**
 :A: Please try out with disabled Antivirus software, there are some known problems with Eset Anitivirus. Make sure
     you have installed latest windows patches (especially KB2789397)
 For further questions search the `Issues tracker`_, or post a message in the
 `google group rhodecode`_
@@ @@ -67,4 +79,4 @@ For further questions search the `Issues @@
 .. _mercurial-server: http://www.lshift.net/mercurial-server.html
 .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories
 .. _Issues tracker: https://bitbucket.org/marcinkuzminski/rhodecode/issues
 .. _google group rhodecode: http://groups.google.com/group/rhodecode
@@ \ No newline at end of file @@
 .. _google group rhodecode: http://groups.google.com/group/rhodecode

0 comments (0 inline, 0 general)