ipmroved documentation and fixed typos

README.md

@@ -11,7 +11,7 @@
 
 ## Overview
 
-Manage NFS (client) installation and configuration.
+This role manages NFS client installation and configuration using fixed ports.
 
 ## Role Variables
 

defaults/main.yml

@@ -5,10 +5,10 @@
 nfs_cli_manage: true
 nfs_cli_pkg_state: 'installed'
 nfs_cli_conf_path: '/etc/default/nfs-common'
-nfs_cli_conf_tpl: 'etc/default/nfs-common.j2'
+nfs_cli_conf_tpl: 'etc/default/nfs-common.j2' # TODO : hide this variable from user, this is for this role's internal use
 
 nfs_quota_conf_path: '/etc/default/quota'
-nfs_quota_conf_tpl: 'etc/default/quota.j2'
+nfs_quota_conf_tpl: 'etc/default/quota.j2' # TODO : hide this variable from user, this is for this role's internal use
 
 # rpcbind
 nfs_rpc_nfsd: '2049'

meta/main.yml

@@ -1,6 +1,6 @@
 galaxy_info:
   author: "Jérémy Gardais"
-  description: "Manage NFS (client/server) installation and configuration"
+  description: "This role manages NFS client installation and configuration using fixed ports"
   license: WTFPL
   company: IPR
   issue_tracker_url: https://git.ipr.univ-rennes1.fr/cellinfo/ansible.nfs/issues

tasks/main.yml

@@ -1,23 +1,23 @@
 ---
-# tasks file for nfs
+# tasks file for role nfs
 
-- name: Load specific OS vars for nfs
-  include_vars: "{{ item }}"
+- name: load operating system specific variables for nfs 
+  include_vars: "{{ item }}" # includes yml file containing os specific variable, eg "debian.yml" found in role_root/vars
   with_first_found:
     - "{{ ansible_distribution|lower }}-{{ ansible_distribution_version }}.yml"
     - "{{ ansible_distribution|lower }}.yml"
     - "{{ ansible_os_family|lower }}.yml"
 
 # client {{{
-- name: client package
+- name: ensure nfs client package is in the required install state
   package:
-    name: '{{ item }}'
+    name: '{{ item }}'   # TODO: why not simply {{ nfs_cli_pkg_list }} ?
     state: '{{ nfs_cli_pkg_state }}'
   with_items:
     - '{{ nfs_cli_pkg_list }}'
   when: nfs_cli_manage
 
-- name: CONFIG nfs-client
+- name: configure nfs-client
   template:
     src: '{{ nfs_cli_conf_tpl }}'
     dest: '{{ nfs_cli_conf_path }}'
@@ -27,7 +27,7 @@
     backup: true
   when: nfs_cli_manage
 
-- name: CONFIG nfs-quota
+- name: configure nfs-quota
   template:
     src: '{{ nfs_quota_conf_tpl }}'
     dest: '{{ nfs_quota_conf_path }}'
@@ -37,7 +37,7 @@
     backup: true
   when: nfs_cli_manage
 
-- name: CONFIG add rpcbind services
+- name: declare rpcbind ports in /etc/services
   blockinfile:
     state: present
     insertafter: EOF