Docs don't cover "generate"

[big-samantha]

The existing docs seem to assume that you already have a castle.

Is there a doc somewhere covering the use of generate to get started with a new castle?

[christianbundy]

I didn't write it originally, so maybe somebody else knows it better, but homesick generate pathname creates a repository at the given path and adds a git origin, so you could do:

homesick generate ~/.homesick/new-repo-name    # create repo
touch ~/.homesick/new-repo-name/home/.touch-me # add your dotfiles
homesick symlink new-repo-name                 # symlink to homedir

And you'll be stylin' with your new dotfiles... which, to start, would just be an empty .touch-me in your home directory.

[big-samantha]

Yeah, I've figured that out for the most part.

Weird thing is, when I try to symlink stuff in my .ssh folder, like ~/.ssh/id_rsa.pub (using a private git repo of course), it's symlinking the actual .ssh folder instead of the files.

But when I symlink ~/.config/awesome/rc.lua it's symlinking that file specifically.

Any idea why the behavior is different? I'm not really into the directory-symlinking but it's not clear how homesick makes the decision.

[christianbundy]

Just to be clear, does that have to do with the behavior of the generate command, or the symlink command? I just want to make sure that I'm looking in the right place to be able to tackle the issue. Thanks!

[big-samantha]

Definitely the symlink command - it's just a challenge faced when you
generate a new castle.

On Tue, Dec 3, 2013 at 1:59 PM, Christian Bundy notifications@github.comwrote:

Just to be clear, does that have to do with the behavior of the generatecommand, or the
symlink command? I just want to make sure that I'm looking in the right
place to be able to tackle the issue. Thanks!

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/65#issuecomment-29755889
.

[wjbuys]

@zacharyalexstern the behaviour is determined by .homesick_subdir. See #12 for more context.

The docs are, unfortunately, not very clear on this. If you can suggest a better way to explain it, feel free to send a PR ;)

[big-samantha]

@wjbuys I don't understand how it actually works / makes decisions, so I have no idea how to document it :)

[christianbundy]

By default, Homesick will only symlink the first folder. The reason that you're getting your files symlinked in .config/awesome instead is because you have it set that way in your repo.

[big-samantha]

Hmm. I certainly didn't do that knowingly. Is there a specific command that
would cause that file to be generated?

On Tue, Dec 3, 2013 at 5:10 PM, Christian Bundy notifications@github.comwrote:

By default, Homesick will only symlink the folder. The reason that you're
getting your files symlinked in .config/awesome instead is because you
have it set that way in your repohttps://github.com/zacharyalexstern/dotfiles/blob/master/.homesick_subdir
.

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/65#issuecomment-29768734
.

[christianbundy]

The documentation is a little hard to wrap your head around, and should be rewritten when somebody (maybe myself) has some time. The lines in your file would have been generated with

homesick track .weechat dotfiles
homesick track .config/awesome dotfiles

[big-samantha]

Now I'm more confused than before.

homesick track .weechat only symlinks the files inside?

But homesick track .ssh/config tracks the whole ssh dir instead of that
config file?

That seems backwards.
Because the latter is what I was doing, and it caused the directory to be
symlinked rather then the files.

Because that sounds backwards...
On Dec 3, 2013 5:54 PM, "Christian Bundy" notifications@github.com wrote:

The documentation is a little hard to wrap your head around, and should be
rewritten when somebody (maybe myself) has some time. The lines in your
file would have been generated with

homesick track .weechat dotfiles
homesick track .config/awesome dotfiles

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/65#issuecomment-29770963
.

[christianbundy]

homesick track .folder dotfiles will tell homesick not to symlink .folder, but to instead symlink the contents of .folder.

To symlink the contents of .ssh instead of the folder itself, you'd be using homesick track .ssh, not homesick track .ssh/config dotfiles

[big-samantha]

Holy cow is that counterintuitive! It's the exact opposite of what a user
would expect.
On Dec 3, 2013 6:14 PM, "Christian Bundy" notifications@github.com wrote:

homesick track .folder will tell homesick not to symlink .folder, but
to instead symlink the contents of .folder.

To symlink the contents of .ssh instead of the folder itself, you'd be
using homesick track .ssh, not homesick track .ssh/config

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/65#issuecomment-29771886
.

[christianbundy]

I agree – it also seems to go against the documentation in the readme, which seems to contradict the initial example.

It looks like the initial example in the readme is how it's working on my computer, not the second example (with the lisp file). Can you verify that it's the same with you?

[nwinkler]

Sounds like a lot of the documentation needs an update ...

[nickserv]

@nwinkler Agreed.