From 9920b96d868d549734a34e053b158cf70da30511 Mon Sep 17 00:00:00 2001 From: Simon Jakobi Date: Sun, 15 May 2016 23:21:51 +0200 Subject: [PATCH 1/2] Docs: Cite package name rules in section for `stack new` [ci skip] --- doc/GUIDE.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/doc/GUIDE.md b/doc/GUIDE.md index 00bbe04f..5bbbdc92 100644 --- a/doc/GUIDE.md +++ b/doc/GUIDE.md @@ -86,9 +86,19 @@ through the most common stack commands. ### stack new -We'll start off with the `stack new` command to create a new -*project*. We'll call our project `helloworld`, and we'll use the -`new-template` project template: +We'll start off with the `stack new` command to create a new *project*, that +will contain a Haskell *package* of the same name. So let's pick a valid +package name first: + +> A package is identified by a globally-unique package name, which consists +of one or more alphanumeric words separated by hyphens. To avoid ambiguity, +each of these words should contain at least one letter. Chaos will result if +two distinct packages with the same name are installed on the same system. + +(From the [Cabal users guide](https://www.haskell.org/cabal/users-guide/developing-packages.html#developing-packages)) + +We'll call our project `helloworld`, and we'll use the `new-template` project +template: ``` michael@d30748af6d3d:~$ stack new helloworld new-template From 4c85869fa04d4358f313340e3c6bcd47dbc64521 Mon Sep 17 00:00:00 2001 From: Simon Jakobi Date: Mon, 16 May 2016 02:36:45 +0200 Subject: [PATCH 2/2] Less chaos [ci skip] --- doc/GUIDE.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/GUIDE.md b/doc/GUIDE.md index 5bbbdc92..b9fcf0d0 100644 --- a/doc/GUIDE.md +++ b/doc/GUIDE.md @@ -92,8 +92,7 @@ package name first: > A package is identified by a globally-unique package name, which consists of one or more alphanumeric words separated by hyphens. To avoid ambiguity, -each of these words should contain at least one letter. Chaos will result if -two distinct packages with the same name are installed on the same system. +each of these words should contain at least one letter. (From the [Cabal users guide](https://www.haskell.org/cabal/users-guide/developing-packages.html#developing-packages))