Difference between revisions of "Removing binaries from transducer repo"

From LING073
Jump to: navigation, search
 
Line 1: Line 1:
 +
You shouldn't have compiled files in your repository.
 +
 +
You also shouldn't have temporary files from your editor committeed.
 +
 
In principle, these days the <code>.gitignore</code> file will be specified to ignore any compiled or binary files.  But it's worth a quick glance to make sure nothing's slipped past it.
 
In principle, these days the <code>.gitignore</code> file will be specified to ignore any compiled or binary files.  But it's worth a quick glance to make sure nothing's slipped past it.
  
 
# [[Bootstrapping a transducer|Bootstrap a fresh transducer]] directory
 
# [[Bootstrapping a transducer|Bootstrap a fresh transducer]] directory
−
# Examine the contents of that directory and your repo side-by-side and compare.  Make sure to use <code>ls -la</code> so that you can see "hidden" files (i.e., ones that start with <code>.</code>)
+
# Examine the contents of that directory and your repo (either a fresh clone or the listing on github) side-by-side and compare.  Make sure to use <code>ls -la</code> so that you can see "hidden" files (i.e., ones that start with <code>.</code>)
−
#* Obvious unwanted files are anything ending in <code>.bin</code>, <code>.hfst</code>, <code>.gz</code>, anything in the <code>.deps</code> or <code>autom4te.cache</code> directories (and the directories themselves, though git doesn't track directories explicitly, so removing all files in them is sufficient), vim swap files (starting with <code>.</code> and ending with <code>.swp</code> or similar), etc.
+
#* Obvious unwanted files are anything ending in <code>.bin</code>, <code>.hfst</code>, <code>.gz</code>, anything in the <code>.deps</code> or <code>autom4te.cache</code> directories (and the directories themselves, though git doesn't track directories explicitly, so removing all files in them is sufficient), vim swap files (starting with <code>.</code> and ending with <code>.swp</code> or similar), anything with a <code>~</code> in it, etc.
 
#* You'll also want to remove files in <code>test/</code> that contain <code>output</code> in the filename.  For each test, you should only have at most <code>input</code>, <code>gold</code>, and <code>expected</code>.
 
#* You'll also want to remove files in <code>test/</code> that contain <code>output</code> in the filename.  For each test, you should only have at most <code>input</code>, <code>gold</code>, and <code>expected</code>.
 
# Use <code>git rm --cached [filename1 filename2 .deps/* etc.]</code> to remove any unwanted files from the repo and leave them on your local system.
 
# Use <code>git rm --cached [filename1 filename2 .deps/* etc.]</code> to remove any unwanted files from the repo and leave them on your local system.

Latest revision as of 13:30, 21 April 2026

You shouldn't have compiled files in your repository.

You also shouldn't have temporary files from your editor committeed.

In principle, these days the .gitignore file will be specified to ignore any compiled or binary files. But it's worth a quick glance to make sure nothing's slipped past it.

  1. Bootstrap a fresh transducer directory
  2. Examine the contents of that directory and your repo (either a fresh clone or the listing on github) side-by-side and compare. Make sure to use ls -la so that you can see "hidden" files (i.e., ones that start with .)
    • Obvious unwanted files are anything ending in .bin, .hfst, .gz, anything in the .deps or autom4te.cache directories (and the directories themselves, though git doesn't track directories explicitly, so removing all files in them is sufficient), vim swap files (starting with . and ending with .swp or similar), anything with a ~ in it, etc.
    • You'll also want to remove files in test/ that contain output in the filename. For each test, you should only have at most input, gold, and expected.
  3. Use git rm --cached [filename1 filename2 .deps/* etc.] to remove any unwanted files from the repo and leave them on your local system.
  4. Use git commit and git push to commit and push the changes.