プロジェクト

全般

プロフィール

Vote #70611

完了

Improve wording of Git repository note at project setting

Admin Redmine さんが3年以上前に追加. 3年以上前に更新.

ステータス:
Closed
優先度:
通常
担当者:
-
カテゴリ:
SCM_3
対象バージョン:
開始日:
2011/08/26
期日:
進捗率:

0%

予定工数:
category_id:
3
version_id:
36
issue_org_id:
9129
author_id:
2460
assigned_to_id:
11192
comments:
7
status_id:
5
tracker_id:
3
plus1:
0
affected_version:
closed_on:
affected_version_id:
ステータス-->[Closed]

説明

Setting up git usually involves either:

git clone git://github.com/ook/donebox.git

or

mkdir foo; cd foo; git init

Redmine wants its git repository set up in a "nonstandard", "bare" way.

So it's very easy to get the setup wrong (#9128), the error messages are not really helpful, there is no help from the setup page itself and "the relevant help page":http://www.redmine.org/projects/redmine/wiki/RedmineRepositories#Git-repository in the Redmine wiki is hard to find and the text accompanying the relevant configuration option is "easy to missunderstand":http://www.redmine.org/projects/redmine/wiki/RedmineRepositories/diff?project_id=redmine&version=40&version_from=39&commit=View+differences.

I'd like to suggest the following changes:

  1. change the text that accompanies the "path" configuration option from "Bare and local repository (e.g. /gitrepo, c:\gitrepo)" to "repository that is bare and local (e.g. /gitrepo, c:\gitrepo)". (see "here":http://www.redmine.org/projects/redmine/wiki/RedmineRepositories/diff?project_id=redmine&version=40&version_from=39&commit=View+differences for the rationale)

  2. Add a "Help" link to the text that is accompanying the "path" configuration option, that points to http://www.redmine.org/projects/redmine/wiki/RedmineRepositories#Git-repository


journals

Second try, produced the correct patch
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
I accept your request of improvement git note from r6636 to r6640 in trunk.
Because #8594 has a suggestion to change git note.

But, I can not accept to add wiki link.
* It is too hard to maintain.
* It is strange in only git setting.
* I will improve fetching error message at #4741.

--------------------------------------------------------------------------------
Hi Toshi,

> But, I can not accept to add wiki link

so, allthough I've been now using git for like two years, Redmine was the _first_ time I was introduced to the notion of a "bare" repository. I had never needed that feature before nor had any recipe on the internets.

If the user gets it wrong, will your error message point them to the wiki page or give instructions?

How are people, maybe even ones that are new to git, supposed to find out how to set up their repositories?

Try once how hard it is to find the correct wiki help page through Redmine's search. Also check the number of people that get stuck:

http://www.google.com/search?q=%22fatal%3A+Not+a+git+repository%22+git+redmine

(it took me about 5 hours yesterday, which included debugging the code on a Windows machine)

It'd be nice if the setup was trivial and everybody got it correctly setup without any problems at all in an instant? So what's the way to get to that point?
--------------------------------------------------------------------------------
The bare repository requirement is one of FAQs before 1.1.
So, I added *bare* word.
Other FAQs:

* Repository permission
* command path
* repository path
** file://gitrepo and file://hgrepo are incorrect.

Other FAQs are subversion xml parsing error and #4741.
So I will improve fetching error message.

I think the bare repository requirement description is enough in r6640.

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------


related_issues

relates,Closed,8594,pt-BR translation update
relates,Closed,9128,Redmine sugestion of the git repository path is incorrect
relates,New,4741,Improve Bazaar repositories error message in case to use shared repository
relates,Closed,9210,Traditional Chinese language file (to r7077)

Admin Redmine さんが3年以上前に更新

  • カテゴリSCM_3 にセット
  • 対象バージョン1.3.0_36 にセット

他の形式にエクスポート: Atom PDF

いいね!0
いいね!0