Browse files

unhide git_commit_info.ini

installing hidden files in system paths is bad style
closes #1484
  • Loading branch information...
1 parent 6db7d23 commit b6f1b6e51d2b562fbfbf244b47e45d86f5f552af @juliantaylor committed Mar 25, 2012
Showing with 10 additions and 10 deletions.
  1. 0 IPython/{.git_commit_info.ini → git_commit_info.ini}
  2. +1 −1 IPython/utils/sysinfo.py
  3. +1 −1 MANIFEST.in
  4. +8 −8 setupbase.py
View
0 IPython/.git_commit_info.ini → IPython/git_commit_info.ini
File renamed without changes.
View
2 IPython/utils/sysinfo.py
@@ -28,7 +28,7 @@
#-----------------------------------------------------------------------------
# Globals
#-----------------------------------------------------------------------------
-COMMIT_INFO_FNAME = '.git_commit_info.ini'
+COMMIT_INFO_FNAME = 'git_commit_info.ini'
#-----------------------------------------------------------------------------
# Code
View
2 MANIFEST.in
@@ -14,7 +14,7 @@ prune IPython/deathrow
prune IPython/frontend/html/notebook/static/mathjax
# Include some specific files and data resources we need
-include IPython/.git_commit_info.ini
+include IPython/git_commit_info.ini
include IPython/frontend/qt/console/resources/icon/IPythonConsole.svg
# Documentation
View
16 setupbase.py
@@ -371,13 +371,13 @@ def record_commit_info(pkg_dir, build_cmd=build_py):
The extended command tries to run git to find the current commit, getting
the empty string if it fails. It then writes the commit hash into a file
- in the `pkg_dir` path, named ``.git_commit_info.ini``.
+ in the `pkg_dir` path, named ``git_commit_info.ini``.
In due course this information can be used by the package after it is
installed, to tell you what commit it was installed from if known.
- To make use of this system, you need a package with a .git_commit_info.ini
- file - e.g. ``myproject/.git_commit_info.ini`` - that might well look like
+ To make use of this system, you need a package with a git_commit_info.ini
+ file - e.g. ``myproject/git_commit_info.ini`` - that might well look like
this::
# This is an ini file that may contain information about the code state
@@ -388,13 +388,13 @@ def record_commit_info(pkg_dir, build_cmd=build_py):
# This line may be modified by the install process
install_hash=
- The .git_commit_info file above is also designed to be used with git
+ The git_commit_info file above is also designed to be used with git
substitution - so you probably also want a ``.gitattributes`` file in the
root directory of your working tree that contains something like this::
- myproject/.git_commit_info.ini export-subst
+ myproject/git_commit_info.ini export-subst
- That will cause the ``.git_commit_info.ini`` file to get filled in by ``git
+ That will cause the ``git_commit_info.ini`` file to get filled in by ``git
archive`` - useful in case someone makes such an archive - for example with
via the github 'download source' button.
@@ -415,13 +415,13 @@ def run(self):
repo_commit, _ = proc.communicate()
# We write the installation commit even if it's empty
cfg_parser = ConfigParser()
- cfg_parser.read(pjoin(pkg_dir, '.git_commit_info.ini'))
+ cfg_parser.read(pjoin(pkg_dir, 'git_commit_info.ini'))
if not cfg_parser.has_section('commit hash'):
# just in case the ini file is empty or doesn't exist, somehow
# we don't want the next line to raise
cfg_parser.add_section('commit hash')
cfg_parser.set('commit hash', 'install_hash', repo_commit.decode('ascii'))
- out_pth = pjoin(self.build_lib, pkg_dir, '.git_commit_info.ini')
+ out_pth = pjoin(self.build_lib, pkg_dir, 'git_commit_info.ini')
out_file = open(out_pth, 'wt')
cfg_parser.write(out_file)
out_file.close()

0 comments on commit b6f1b6e

Please sign in to comment.