Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Target/source terminology #257

Open
bricoletc opened this issue Jan 29, 2021 · 1 comment
Open

Target/source terminology #257

bricoletc opened this issue Jan 29, 2021 · 1 comment

Comments

@bricoletc
Copy link

Hi, first of all thanks for this great resource.

I get confused by the use of the words target/source, for eg in describing the Link directive:

Link commands are specified as a dictionary mapping targets to source locations

In my understanding, a symlink has a target, the file it points to. (eg man ln says: In the 1st form, create a link to TARGET with the name LINK_NAME.)

So I think it's clearer to say something like

Link commands are specified as a dictionary mapping symlink names to their targets

More generally, it would help to have a sentence at the beginning saying that dotbot works by i)taking a list of version-controlled dotfiles cloned on a system ii) making symlinks pointing to those dotfiles on the system and iii) the install.config.yaml specifying which pairs of symlink -> target dotfile to make.

@anishathalye
Copy link
Owner

That's a good suggestion. Even I sometimes find the current terminology confusing when working on the source code. It would be nice to update both the documentation and the code to use a unified and less confusing terminology.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants