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

suggestions for improvements on docs for watch.* #996

Closed
insasho opened this issue Oct 9, 2015 · 3 comments
Closed

suggestions for improvements on docs for watch.* #996

insasho opened this issue Oct 9, 2015 · 3 comments
Assignees
Milestone

Comments

@insasho
Copy link

insasho commented Oct 9, 2015

Regarding https://revel.github.io/manual/appconf.html#watchers:

  1. The docs for watch.mode refers to watchers.mode. This is ambiguous. Which one is it?
  2. watch.mode and watch.code both have a dedicated paragraph for Default setting, but watch.templates and watch.routes specify the default value in parenthesis.
  3. Are the docs correct in stating that watch.templates and watch.routes both default to false? Watch mode w/o watching templates seems a little silly.
  4. Watch seems to be implemented with inotify, which is incompatible with VirtualBox shared filesystems (vboxsf) and some other filesystems. Mentioning inotify in this section might save devs some time.

Thanks!

@ghost
Copy link

ghost commented Oct 10, 2015

@insasho 👍 for the improvement of docs. As for the 4th point, have you ever visited fsnotify's home page?

https://fsnotify.org/
From the beginning, fsnotify had users, with Rob Figueiredo testing it on OS X and later adopting it for Revel.

@insasho
Copy link
Author

insasho commented Oct 10, 2015

I was not aware that Revel was using fsnotify. Thanks for the pointer. I'm glad to see https://github.com/go-fsnotify/fsnotify/issues/9 is a feature request for adding polling to fsnotify. I still think it would be useful to mention that watch won't work on many platforms from within a VM as this is a common case.

@pedromorgan pedromorgan self-assigned this May 20, 2016
@brendensoares brendensoares added this to the v0.13 milestone May 20, 2016
jeevatkm added a commit to revel/revel.github.io that referenced this issue May 29, 2016
@jeevatkm
Copy link
Contributor

Taken care.

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

4 participants