Library functions and modules should be in the 3 man page section. Al…

…so the files should end in '.3'
AndreTurgeon · Oct 3, 2012 · 85fb7c6 · 85fb7c6
1 parent 53d24ef
commit 85fb7c6
Show file tree

Hide file tree

Showing 45 changed files with 10 additions and 8 deletions.
diff --git a/Makefile b/Makefile
@@ -9,7 +9,7 @@
 #   make deb ------------------ produce a DEB
 #   make docs ----------------- rebuild the manpages (results are checked in)
 #   make tests ---------------- run the tests
-#   make pyflakes, make pep8 -- source code checks  
+#   make pyflakes, make pep8 -- source code checks
 
 ########################################################
 # variable section
@@ -58,7 +58,7 @@ RPMNVR = "$(NAME)-$(VERSION)-$(RPMRELEASE)$(RPMDIST)"
 
 all: clean python
 
-tests: 
+tests:
 	PYTHONPATH=./lib nosetests -d -v
 
 # To force a rebuild of the docs run 'touch VERSION && make docs'
@@ -161,4 +161,4 @@ deb: debian
 # for arch or gentoo, read instructions in the appropriate 'packaging' subdirectory directory
 
 modulepages:
-	hacking/module_formatter.py -A $(VERSION) -t man -o docs/man/man1/ --module-dir=library --template-dir=hacking/templates
+	hacking/module_formatter.py -A $(VERSION) -t man -o docs/man/man3/ --module-dir=library --template-dir=hacking/templates
diff --git a/docs/man/man1/ansible.apt.man → docs/man/man3/ansible.apt.3 b/docs/man/man1/ansible.apt.man → docs/man/man3/ansible.apt.3
diff --git a/docs/man/man1/ansible.apt_repository.man → docs/man/man3/ansible.apt_repository.3 b/docs/man/man1/ansible.apt_repository.man → docs/man/man3/ansible.apt_repository.3
diff --git a/docs/man/man1/ansible.assemble.man → docs/man/man3/ansible.assemble.3 b/docs/man/man1/ansible.assemble.man → docs/man/man3/ansible.assemble.3
diff --git a/docs/man/man1/ansible.async_status.man → docs/man/man3/ansible.async_status.3 b/docs/man/man1/ansible.async_status.man → docs/man/man3/ansible.async_status.3
diff --git a/docs/man/man1/ansible.authorized_key.man → docs/man/man3/ansible.authorized_key.3 b/docs/man/man1/ansible.authorized_key.man → docs/man/man3/ansible.authorized_key.3
diff --git a/docs/man/man1/ansible.command.man → docs/man/man3/ansible.command.3 b/docs/man/man1/ansible.command.man → docs/man/man3/ansible.command.3
diff --git a/docs/man/man1/ansible.copy.man → docs/man/man3/ansible.copy.3 b/docs/man/man1/ansible.copy.man → docs/man/man3/ansible.copy.3
diff --git a/docs/man/man1/ansible.easy_install.man → docs/man/man3/ansible.easy_install.3 b/docs/man/man1/ansible.easy_install.man → docs/man/man3/ansible.easy_install.3
diff --git a/docs/man/man1/ansible.facter.man → docs/man/man3/ansible.facter.3 b/docs/man/man1/ansible.facter.man → docs/man/man3/ansible.facter.3
diff --git a/docs/man/man1/ansible.fail.man → docs/man/man3/ansible.fail.3 b/docs/man/man1/ansible.fail.man → docs/man/man3/ansible.fail.3
diff --git a/docs/man/man1/ansible.fetch.man → docs/man/man3/ansible.fetch.3 b/docs/man/man1/ansible.fetch.man → docs/man/man3/ansible.fetch.3
diff --git a/docs/man/man1/ansible.file.man → docs/man/man3/ansible.file.3 b/docs/man/man1/ansible.file.man → docs/man/man3/ansible.file.3
diff --git a/docs/man/man1/ansible.fireball.man → docs/man/man3/ansible.fireball.3 b/docs/man/man1/ansible.fireball.man → docs/man/man3/ansible.fireball.3
diff --git a/docs/man/man1/ansible.get_url.man → docs/man/man3/ansible.get_url.3 b/docs/man/man1/ansible.get_url.man → docs/man/man3/ansible.get_url.3
diff --git a/docs/man/man1/ansible.git.man → docs/man/man3/ansible.git.3 b/docs/man/man1/ansible.git.man → docs/man/man3/ansible.git.3
diff --git a/docs/man/man1/ansible.group.man → docs/man/man3/ansible.group.3 b/docs/man/man1/ansible.group.man → docs/man/man3/ansible.group.3
diff --git a/docs/man/man1/ansible.ini_file.man → docs/man/man3/ansible.ini_file.3 b/docs/man/man1/ansible.ini_file.man → docs/man/man3/ansible.ini_file.3
diff --git a/docs/man/man1/ansible.lineinfile.man → docs/man/man3/ansible.lineinfile.3 b/docs/man/man1/ansible.lineinfile.man → docs/man/man3/ansible.lineinfile.3
diff --git a/docs/man/man1/ansible.mount.man → docs/man/man3/ansible.mount.3 b/docs/man/man1/ansible.mount.man → docs/man/man3/ansible.mount.3
diff --git a/docs/man/man1/ansible.mysql_db.man → docs/man/man3/ansible.mysql_db.3 b/docs/man/man1/ansible.mysql_db.man → docs/man/man3/ansible.mysql_db.3
diff --git a/docs/man/man1/ansible.mysql_user.man → docs/man/man3/ansible.mysql_user.3 b/docs/man/man1/ansible.mysql_user.man → docs/man/man3/ansible.mysql_user.3
diff --git a/docs/man/man1/ansible.nagios.man → docs/man/man3/ansible.nagios.3 b/docs/man/man1/ansible.nagios.man → docs/man/man3/ansible.nagios.3
diff --git a/docs/man/man1/ansible.ohai.man → docs/man/man3/ansible.ohai.3 b/docs/man/man1/ansible.ohai.man → docs/man/man3/ansible.ohai.3
diff --git a/docs/man/man1/ansible.pause.man → docs/man/man3/ansible.pause.3 b/docs/man/man1/ansible.pause.man → docs/man/man3/ansible.pause.3
diff --git a/docs/man/man1/ansible.ping.man → docs/man/man3/ansible.ping.3 b/docs/man/man1/ansible.ping.man → docs/man/man3/ansible.ping.3
diff --git a/docs/man/man1/ansible.pip.man → docs/man/man3/ansible.pip.3 b/docs/man/man1/ansible.pip.man → docs/man/man3/ansible.pip.3
diff --git a/docs/man/man1/ansible.postgresql_db.man → docs/man/man3/ansible.postgresql_db.3 b/docs/man/man1/ansible.postgresql_db.man → docs/man/man3/ansible.postgresql_db.3
diff --git a/docs/man/man1/ansible.postgresql_user.man → docs/man/man3/ansible.postgresql_user.3 b/docs/man/man1/ansible.postgresql_user.man → docs/man/man3/ansible.postgresql_user.3
diff --git a/docs/man/man1/ansible.raw.man → docs/man/man3/ansible.raw.3 b/docs/man/man1/ansible.raw.man → docs/man/man3/ansible.raw.3
diff --git a/docs/man/man1/ansible.seboolean.man → docs/man/man3/ansible.seboolean.3 b/docs/man/man1/ansible.seboolean.man → docs/man/man3/ansible.seboolean.3
diff --git a/docs/man/man1/ansible.selinux.man → docs/man/man3/ansible.selinux.3 b/docs/man/man1/ansible.selinux.man → docs/man/man3/ansible.selinux.3
diff --git a/docs/man/man1/ansible.service.man → docs/man/man3/ansible.service.3 b/docs/man/man1/ansible.service.man → docs/man/man3/ansible.service.3
diff --git a/docs/man/man1/ansible.setup.man → docs/man/man3/ansible.setup.3 b/docs/man/man1/ansible.setup.man → docs/man/man3/ansible.setup.3
diff --git a/docs/man/man1/ansible.shell.man → docs/man/man3/ansible.shell.3 b/docs/man/man1/ansible.shell.man → docs/man/man3/ansible.shell.3
diff --git a/docs/man/man1/ansible.slurp.man → docs/man/man3/ansible.slurp.3 b/docs/man/man1/ansible.slurp.man → docs/man/man3/ansible.slurp.3
diff --git a/docs/man/man1/ansible.subversion.man → docs/man/man3/ansible.subversion.3 b/docs/man/man1/ansible.subversion.man → docs/man/man3/ansible.subversion.3
diff --git a/docs/man/man1/ansible.supervisorctl.man → docs/man/man3/ansible.supervisorctl.3 b/docs/man/man1/ansible.supervisorctl.man → docs/man/man3/ansible.supervisorctl.3
diff --git a/docs/man/man1/ansible.template.man → docs/man/man3/ansible.template.3 b/docs/man/man1/ansible.template.man → docs/man/man3/ansible.template.3
diff --git a/docs/man/man1/ansible.user.man → docs/man/man3/ansible.user.3 b/docs/man/man1/ansible.user.man → docs/man/man3/ansible.user.3
diff --git a/docs/man/man1/ansible.virt.man → docs/man/man3/ansible.virt.3 b/docs/man/man1/ansible.virt.man → docs/man/man3/ansible.virt.3
diff --git a/docs/man/man1/ansible.wait_for.man → docs/man/man3/ansible.wait_for.3 b/docs/man/man1/ansible.wait_for.man → docs/man/man3/ansible.wait_for.3
diff --git a/docs/man/man1/ansible.yum.man → docs/man/man3/ansible.yum.3 b/docs/man/man1/ansible.yum.man → docs/man/man3/ansible.yum.3
diff --git a/hacking/module_formatter.py b/hacking/module_formatter.py
@@ -148,7 +148,7 @@ def get_docstring(filename, verbose=False):
             if isinstance(child, ast.Assign):
                 if 'DOCUMENTATION' in (t.id for t in child.targets):
                     doc = yaml.load(child.value.s)
-                 
+
     except:
         if verbose:
             raise
@@ -210,7 +210,7 @@ def main():
 
     module_dir = None
     args = p.parse_args()
-    
+
     # print "M: %s" % args.module_dir
     # print "t: %s" % args.type
     # print "m: %s" % args.module_list
@@ -251,7 +251,7 @@ def main():
     if args.type == 'man':
         env.filters['jpfunc'] = man_ify
         template = env.get_template('man.j2')
-        outputname = "ansible.%s.man"
+        outputname = "ansible.%s.3"
         includecmt = ""
         includefmt = ""
     if args.type == 'rst':
@@ -330,7 +330,7 @@ def main():
 #
 #    # Sneaky: insert author's name from Git config
 #
-#    cmd = subprocess.Popen("git config --get user.name", shell=True, 
+#    cmd = subprocess.Popen("git config --get user.name", shell=True,
 #            stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 #    out, err = cmd.communicate()
 #

diff --git a/packaging/rpm/ansible.spec b/packaging/rpm/ansible.spec
@@ -40,8 +40,9 @@ are transferred to managed machines automatically.
 mkdir -p $RPM_BUILD_ROOT/etc/ansible/
 cp examples/hosts $RPM_BUILD_ROOT/etc/ansible/
 cp examples/ansible.cfg $RPM_BUILD_ROOT/etc/ansible/
-mkdir -p $RPM_BUILD_ROOT/%{_mandir}/man1/
+mkdir -p $RPM_BUILD_ROOT/%{_mandir}/{man1,man3}/
 cp -v docs/man/man1/*.1 $RPM_BUILD_ROOT/%{_mandir}/man1/
+cp -v docs/man/man3/*.3 $RPM_BUILD_ROOT/%{_mandir}/man3/
 mkdir -p $RPM_BUILD_ROOT/%{_datadir}/ansible
 cp -v library/* $RPM_BUILD_ROOT/%{_datadir}/ansible/
 
@@ -56,6 +57,7 @@ rm -rf $RPM_BUILD_ROOT
 %config(noreplace) %{_sysconfdir}/ansible
 %doc README.md PKG-INFO COPYING
 %doc %{_mandir}/man1/ansible*
+%doc %{_mandir}/man3/ansible.*
 %doc examples/playbooks
 
 %changelog