Remove derived PDFs from repo; now in 'src' repo, comstructed by HCFI…

…LES and MAKE-INDEX-HTMLS (#1657) * Remove derived PDFs from branch other than gh-pages * only the gh-pages branch should have the pdfs * make pdfs and listings * Update HCFILES and MAKE-INDEX-HTMLS, add preliminary documentation * add a slashit to avoid angle brackets
Interlisp · Apr 29, 2024 · d79d5b3 · d79d5b3
1 parent 14b102f
commit d79d5b3
Show file tree

Hide file tree

Showing 117 changed files with 486 additions and 242 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,13 +5,21 @@ tmp/*
 # releases directory
 releases/*
 
+# all PDFs (those explicitly checked in aren't ignored
+# normally when you have derived files, you ignore them from git
+# because they will get regenerated when you rebuild.
+# MEDLEY-UTILS HCFILES regenerates
+
+*.pdf
+
 
 # all loadup files 
 
 loadups/exports.all
 library/RDSYS*
 loadups/lisp.sysout
 loadups/full.sysout
+loadups/fuller.sysout   # not currently included but might as well ignore it
 loadups/*.dribble
 loadups/whereis.hash
 loadups/apps.sysout

diff --git a/docs/Medley-Primer.pdf b/docs/Medley-Primer.pdf
diff --git a/docs/ReleaseNote/APPENDIXA-THEEXEC.pdf b/docs/ReleaseNote/APPENDIXA-THEEXEC.pdf
diff --git a/docs/ReleaseNote/APPENDIXA-THEEXECtmp.pdf b/docs/ReleaseNote/APPENDIXA-THEEXECtmp.pdf
diff --git a/docs/ReleaseNote/APPENDIXB-SEDIT.pdf b/docs/ReleaseNote/APPENDIXB-SEDIT.pdf
diff --git a/docs/ReleaseNote/APPENDIXC-ICONW.pdf b/docs/ReleaseNote/APPENDIXC-ICONW.pdf
diff --git a/docs/ReleaseNote/APPENDIXE-ERRSYS.pdf b/docs/ReleaseNote/APPENDIXE-ERRSYS.pdf
diff --git a/docs/ReleaseNote/ENVOSCOVERSHEET.pdf b/docs/ReleaseNote/ENVOSCOVERSHEET.pdf
diff --git a/docs/ReleaseNote/Indexfinal.pdf b/docs/ReleaseNote/Indexfinal.pdf
diff --git a/docs/ReleaseNote/LOT.pdf b/docs/ReleaseNote/LOT.pdf
diff --git a/docs/ReleaseNote/PREFACE.pdf b/docs/ReleaseNote/PREFACE.pdf
diff --git a/docs/ReleaseNote/PRINTINGSPEC.pdf b/docs/ReleaseNote/PRINTINGSPEC.pdf
diff --git a/docs/ReleaseNote/SEC1-INTRODUCTION.pdf b/docs/ReleaseNote/SEC1-INTRODUCTION.pdf
diff --git a/docs/ReleaseNote/SEC2-NOTES-AND-CAUTIONS.pdf b/docs/ReleaseNote/SEC2-NOTES-AND-CAUTIONS.pdf
diff --git a/docs/ReleaseNote/SEC3-IRMFEATURES-I.pdf b/docs/ReleaseNote/SEC3-IRMFEATURES-I.pdf
diff --git a/docs/ReleaseNote/SEC3-IRMFEATURES-II.pdf b/docs/ReleaseNote/SEC3-IRMFEATURES-II.pdf
diff --git a/docs/ReleaseNote/SEC3-IRMFEATURES-III.pdf b/docs/ReleaseNote/SEC3-IRMFEATURES-III.pdf
diff --git a/docs/ReleaseNote/SEC4-IRMERRATA.pdf b/docs/ReleaseNote/SEC4-IRMERRATA.pdf
diff --git a/docs/ReleaseNote/SEC5-LIBRARY-MODULES.pdf b/docs/ReleaseNote/SEC5-LIBRARY-MODULES.pdf
diff --git a/docs/ReleaseNote/SEC6-USERS-GUIDES.pdf b/docs/ReleaseNote/SEC6-USERS-GUIDES.pdf
diff --git a/docs/ReleaseNote/SEC7-CLIMPLMNTN.pdf b/docs/ReleaseNote/SEC7-CLIMPLMNTN.pdf
diff --git a/docs/ReleaseNote/TABS2L.pdf b/docs/ReleaseNote/TABS2L.pdf
diff --git a/docs/ReleaseNote/TABSINFOP.pdf b/docs/ReleaseNote/TABSINFOP.pdf
diff --git a/docs/ReleaseNote/TABSLAYOUTL.pdf b/docs/ReleaseNote/TABSLAYOUTL.pdf
diff --git a/docs/ReleaseNote/TABSPEC.pdf b/docs/ReleaseNote/TABSPEC.pdf
diff --git a/docs/ReleaseNote/TOC.pdf b/docs/ReleaseNote/TOC.pdf
diff --git a/docs/ReleaseNote/Tab-Replacements.pdf b/docs/ReleaseNote/Tab-Replacements.pdf
diff --git a/docs/ReleaseNote/Titlepage.pdf b/docs/ReleaseNote/Titlepage.pdf
diff --git a/docs/ReleaseNote/bindercover.pdf b/docs/ReleaseNote/bindercover.pdf
diff --git a/docs/ReleaseNote/indexbase.pdf b/docs/ReleaseNote/indexbase.pdf
diff --git a/docs/ReleaseNote/test.pdf b/docs/ReleaseNote/test.pdf
diff --git a/docs/Sun Users Guide/000-COVER.pdf b/docs/Sun Users Guide/000-COVER.pdf
diff --git a/docs/Sun Users Guide/001-TITLEPAGE.pdf b/docs/Sun Users Guide/001-TITLEPAGE.pdf
diff --git a/docs/Sun Users Guide/002-TOC.pdf b/docs/Sun Users Guide/002-TOC.pdf
diff --git a/docs/Sun Users Guide/003-LOF.pdf b/docs/Sun Users Guide/003-LOF.pdf
diff --git a/docs/Sun Users Guide/004-PREFACE.pdf b/docs/Sun Users Guide/004-PREFACE.pdf
diff --git a/docs/Sun Users Guide/1-INTRODUCTION.pdf b/docs/Sun Users Guide/1-INTRODUCTION.pdf
diff --git a/docs/Sun Users Guide/2-software-installation.pdf b/docs/Sun Users Guide/2-software-installation.pdf
diff --git a/docs/Sun Users Guide/2-software-installation.tedit b/docs/Sun Users Guide/2-software-installation.tedit
diff --git a/docs/Sun Users Guide/3-GETTING-STARTED.pdf b/docs/Sun Users Guide/3-GETTING-STARTED.pdf
diff --git a/docs/Sun Users Guide/4-USING-MEDLEY.pdf b/docs/Sun Users Guide/4-USING-MEDLEY.pdf
diff --git a/docs/Sun Users Guide/5-MEDLEY-FILES.pdf b/docs/Sun Users Guide/5-MEDLEY-FILES.pdf
diff --git a/docs/Sun Users Guide/6-ERRORS.pdf b/docs/Sun Users Guide/6-ERRORS.pdf
diff --git a/docs/Sun Users Guide/APP-A-INSTALL-HINTS.pdf b/docs/Sun Users Guide/APP-A-INSTALL-HINTS.pdf
diff --git a/docs/Sun Users Guide/APP-B-VERIFYING-TAPE-VALIDITY.pdf b/docs/Sun Users Guide/APP-B-VERIFYING-TAPE-VALIDITY.pdf
diff --git a/docs/Sun Users Guide/APP-C-FILE-LAYOUT.pdf b/docs/Sun Users Guide/APP-C-FILE-LAYOUT.pdf
diff --git a/docs/Sun Users Guide/APP-D-DIFFERENCES.pdf b/docs/Sun Users Guide/APP-D-DIFFERENCES.pdf
diff --git a/docs/Sun Users Guide/COVERMEMO.pdf b/docs/Sun Users Guide/COVERMEMO.pdf
diff --git a/docs/Sun Users Guide/GLOSSARY.pdf b/docs/Sun Users Guide/GLOSSARY.pdf
diff --git a/docs/Sun Users Guide/INDEX.pdf b/docs/Sun Users Guide/INDEX.pdf
diff --git a/docs/Sun-Users-Guide.pdf b/docs/Sun-Users-Guide.pdf
diff --git a/docs/medley-irm/001-TITLEPAGE.pdf b/docs/medley-irm/001-TITLEPAGE.pdf
diff --git a/docs/medley-irm/003-TOC.pdf b/docs/medley-irm/003-TOC.pdf
diff --git a/docs/medley-irm/01-INTRO.pdf b/docs/medley-irm/01-INTRO.pdf
diff --git a/docs/medley-irm/02-LITATOM.pdf b/docs/medley-irm/02-LITATOM.pdf
diff --git a/docs/medley-irm/03-lists.pdf b/docs/medley-irm/03-lists.pdf
diff --git a/docs/medley-irm/04-STRINGS.pdf b/docs/medley-irm/04-STRINGS.pdf
diff --git a/docs/medley-irm/05-ARRAY.pdf b/docs/medley-irm/05-ARRAY.pdf
diff --git a/docs/medley-irm/06-HASHARRAYS.pdf b/docs/medley-irm/06-HASHARRAYS.pdf
diff --git a/docs/medley-irm/07-NUMBERS.pdf b/docs/medley-irm/07-NUMBERS.pdf
diff --git a/docs/medley-irm/08-RECORDPACKAGE.pdf b/docs/medley-irm/08-RECORDPACKAGE.pdf
diff --git a/docs/medley-irm/09-conditionals.pdf b/docs/medley-irm/09-conditionals.pdf
diff --git a/docs/medley-irm/10-FUNC-DEF.pdf b/docs/medley-irm/10-FUNC-DEF.pdf
diff --git a/docs/medley-irm/11-VAR-BINDINGS.pdf b/docs/medley-irm/11-VAR-BINDINGS.pdf
diff --git a/docs/medley-irm/12-MISC.pdf b/docs/medley-irm/12-MISC.pdf
diff --git a/docs/medley-irm/13-EXECUTIVE.pdf b/docs/medley-irm/13-EXECUTIVE.pdf
diff --git a/docs/medley-irm/14-ERRORS.pdf b/docs/medley-irm/14-ERRORS.pdf
diff --git a/docs/medley-irm/15-BREAKING.pdf b/docs/medley-irm/15-BREAKING.pdf
diff --git a/docs/medley-irm/16-SEDIT.pdf b/docs/medley-irm/16-SEDIT.pdf
diff --git a/docs/medley-irm/17-FILEPACKAGE.pdf b/docs/medley-irm/17-FILEPACKAGE.pdf
diff --git a/docs/medley-irm/18-COMPILER.pdf b/docs/medley-irm/18-COMPILER.pdf
diff --git a/docs/medley-irm/19-DWIM.pdf b/docs/medley-irm/19-DWIM.pdf
diff --git a/docs/medley-irm/20-CLISP.pdf b/docs/medley-irm/20-CLISP.pdf
diff --git a/docs/medley-irm/21-PERFORMANCE.pdf b/docs/medley-irm/21-PERFORMANCE.pdf
diff --git a/docs/medley-irm/22-PERFORMANCE.pdf b/docs/medley-irm/22-PERFORMANCE.pdf
diff --git a/docs/medley-irm/22-PROCESSES.pdf b/docs/medley-irm/22-PROCESSES.pdf
diff --git a/docs/medley-irm/23-PROCESSES.pdf b/docs/medley-irm/23-PROCESSES.pdf
diff --git a/docs/medley-irm/23-SSTREAMS.pdf b/docs/medley-irm/23-SSTREAMS.pdf
diff --git a/docs/medley-irm/23-STREAMS.pdf b/docs/medley-irm/23-STREAMS.pdf
diff --git a/docs/medley-irm/24-IO.pdf b/docs/medley-irm/24-IO.pdf
diff --git a/docs/medley-irm/25-USERIO-PACKAGES.pdf b/docs/medley-irm/25-USERIO-PACKAGES.pdf
diff --git a/docs/medley-irm/26-GRAPHICS.pdf b/docs/medley-irm/26-GRAPHICS.pdf
diff --git a/docs/medley-irm/27-WINDOWS.pdf b/docs/medley-irm/27-WINDOWS.pdf
diff --git a/docs/medley-irm/28-HARDCOPY.pdf b/docs/medley-irm/28-HARDCOPY.pdf
diff --git a/docs/medley-irm/29-TERMINAL.pdf b/docs/medley-irm/29-TERMINAL.pdf
diff --git a/docs/primer/001-TITLEPAGE.pdf b/docs/primer/001-TITLEPAGE.pdf
diff --git a/docs/primer/002-PREFACE.pdf b/docs/primer/002-PREFACE.pdf
diff --git a/docs/primer/003-TOC.pdf b/docs/primer/003-TOC.pdf
diff --git a/docs/primer/01-GLOSSARY.pdf b/docs/primer/01-GLOSSARY.pdf
diff --git a/docs/primer/02-TYPING-SHORTCUTS.pdf b/docs/primer/02-TYPING-SHORTCUTS.pdf
diff --git a/docs/primer/03-USING-MENUS.pdf b/docs/primer/03-USING-MENUS.pdf
diff --git a/docs/primer/04-USING-FILES.pdf b/docs/primer/04-USING-FILES.pdf
diff --git a/docs/primer/05-FILEBROWSER.pdf b/docs/primer/05-FILEBROWSER.pdf
diff --git a/docs/primer/06-WINDOWS.pdf b/docs/primer/06-WINDOWS.pdf
diff --git a/docs/primer/07-EDITING-AND-SAVING.pdf b/docs/primer/07-EDITING-AND-SAVING.pdf
diff --git a/docs/primer/08-YOUR-INIT.pdf b/docs/primer/08-YOUR-INIT.pdf
diff --git a/docs/primer/09-FLEXIBILITY.pdf b/docs/primer/09-FLEXIBILITY.pdf
diff --git a/docs/primer/10-BREAK-MENU.pdf b/docs/primer/10-BREAK-MENU.pdf
diff --git a/docs/primer/11-WHAT-TO-DO.pdf b/docs/primer/11-WHAT-TO-DO.pdf
diff --git a/docs/primer/12-WINDOWS.pdf b/docs/primer/12-WINDOWS.pdf
diff --git a/docs/primer/13-WHAT-ARE-MENUS.pdf b/docs/primer/13-WHAT-ARE-MENUS.pdf
diff --git a/docs/primer/14-BITMAPS.pdf b/docs/primer/14-BITMAPS.pdf
diff --git a/docs/primer/15-DISPLAYSTREAMS.pdf b/docs/primer/15-DISPLAYSTREAMS.pdf
diff --git a/docs/primer/16-FONTS.pdf b/docs/primer/16-FONTS.pdf
diff --git a/docs/primer/17-INSPECTOR.pdf b/docs/primer/17-INSPECTOR.pdf
diff --git a/docs/primer/18-MASTERSCOPE.pdf b/docs/primer/18-MASTERSCOPE.pdf
diff --git a/docs/primer/19-SPY.pdf b/docs/primer/19-SPY.pdf
diff --git a/docs/primer/20-FREE-MENUS.pdf b/docs/primer/20-FREE-MENUS.pdf
diff --git a/docs/primer/21-GRAPHER.pdf b/docs/primer/21-GRAPHER.pdf
diff --git a/docs/primer/22-RESOURCE-MANAGEMENT.pdf b/docs/primer/22-RESOURCE-MANAGEMENT.pdf
diff --git a/docs/primer/23-INTERACTIONS.pdf b/docs/primer/23-INTERACTIONS.pdf
diff --git a/docs/primer/24-GLOBAL-VARIABLES.pdf b/docs/primer/24-GLOBAL-VARIABLES.pdf
diff --git a/docs/primer/25-REFERENCES.pdf b/docs/primer/25-REFERENCES.pdf
diff --git a/internal/MEDLEY-UTILS b/internal/MEDLEY-UTILS
diff --git a/internal/MEDLEY-UTILS.DFASL b/internal/MEDLEY-UTILS.DFASL
diff --git a/internal/MEDLEY-UTILS.LCOM b/internal/MEDLEY-UTILS.LCOM
diff --git a/scripts/make-gh-pages.md b/scripts/make-gh-pages.md
@@ -0,0 +1,73 @@
+preliminary documentation -- needs validation
+HCFILES writes in {MEDLEYDIR} but it should write in something like (SRCDIR)
+
+# setup
+
+ github pages are maintained in the 'src' repository as a forked repo
+ If you don't have a clone of src: 
+```
+   gh repo clone interlisp/src # make one
+   cd src                      # all other commands 
+```
+the first time once you've cloned, point the 'src' clone 
+```
+   gh remote add upstream https://github.com/interlisp/medley
+
+```
+now update src repository to match 'medley'
+Run these in the 'src' repository!
+
+```
+   git fetch upstream                # pull down remote branches
+   git checkout master               # make sure you're in master
+   git rebase upstream/master        # update src's master
+                                      # to latest medley's master
+   git push -f origin master          # push back go sfc
+```
+
+# Run Medly to create PDFs.
+
+Start with the apps sysout to spare yourself package problems
+In an Interlisp exec:
+```
+  (FILESLOAD PDFSTREAM GITFNS MEDLEY-UTILS)
+  (HCFILES)
+  (MAKE-INDEX-HTMLS)
+```
+check out that it looks right if you point your browser the index/index.hrml at the top level
+
+# deploying
+
+* find the current release tags
+Not sure how to do that.
+
+```
+   wget -l 1 https://github.com/interlisp/medley/releases/latest
+```
+will retrieve a 3xx redirect from the web server;
+But all you need is the name, not the web page.
+anyway, assuming the release is medley-YYMMDD-xxxxxxx. 
+
+put release name in variable
+```
+  export release=medley-240420-1234567
+```
+## make a new branch
+```
+   git checkout -b pages-$release
+```
+*temporarily* change .gitignore to allow checkin of pdfs and index.html
+```
+cp .gitignore /tmp/save$release
+cp .gitignore.for.pages .gitignore
+```
+Now you can push this to the github-pages
+```
+	git add .
+	git commit -m "rerun making ghpages and index"
+	git push
+```
+
+
+
+