[issue637] hg(1) and QuickStart page could be clearer about what precisely is considered "the repository"

[Paul Bx]

New submission from Paul Bx <pb at e-scribe.com>:

The manpage currently states that you use the init command to "initialize a new 
repository in the given directory". As a beginner I found this confusing -- if 
the repo is "in" the given directory, this seemed to imply that the .hg dir was 
the repo. I think a slight wording change could make this significantly clearer. 
Namely: "...initialize the given directory as a new repository".

Likewise, the QuickStart says: "You'll want to start by creating an hg 
repository", but would IMO be clearer with something like "You'll want to start 
by turning your project directory into a Mercurial repository".

For what it's worth, I think the definition found on the UnderstandingMercurial 
page is good: "repositories contain a working directory coupled with a store". 
Just trying to spread some of that clarity around...

----------
messages: 3549
nosy: pbx
priority: wish
status: unread
title: hg(1) and QuickStart page could be clearer about what precisely is considered "the repository"
topic: documentation

____________________________________________________
Mercurial issue tracker <mercurial-bugs at selenic.com>
<http://www.selenic.com/mercurial/bts/issue637>
____________________________________________________