Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add texinfo spec #51

Open
2 tasks done
lucaswerkmeister opened this issue Aug 21, 2015 · 14 comments
Open
2 tasks done

Add texinfo spec #51

lucaswerkmeister opened this issue Aug 21, 2015 · 14 comments
Labels
Milestone

Comments

@lucaswerkmeister
Copy link
Member

  • Add Ant task to copy info files from ../ceylon-spec/build/$lang/info to ../ceylon-dist/dist/doc/info
  • Add commands to install the info file globally to the redhat/ and debian/ scripts (install-info)
@quintesse
Copy link
Member

Why the first item? That's not an officially defined place for documentation

@quintesse quintesse added this to the 1.2 milestone Aug 21, 2015
@lucaswerkmeister
Copy link
Member Author

I had gathered that @jvasileff and @FroMage wanted a way to install the files locally. Not too keen of it myself though, so I won’t mind if we remove that part.

@jvasileff
Copy link
Member

I haven't really paid attention to how most people install Ceylon, but my preference for "local" installs is:

$CEYLON_HOME/doc/info

just like we currently have

$CEYLON_HOME/bin
$CEYLON_HOME/doc/man
...

We should get that "for free", right?

FTR, I am not using ~/.ceylon for CEYLON_HOME. Maybe that's what some people do? Doesn't seem right to me though, since I'd like to maintain multiple installations (1.1.0, 1.1.1, etc.)

@lucaswerkmeister
Copy link
Member Author

Oh, I didn’t know we already had /doc/man. Then of course the info belongs in /doc/info. Updated the issue. Thanks!

@quintesse
Copy link
Member

FTR, I am not using ~/.ceylon for CEYLON_HOME. Maybe that's what some people do?

I doubt that would work and even if it did it's definitely not supported! ;)

@quintesse
Copy link
Member

NB: updated the text again @lucaswerkmeister because in the build you can't refer to ${CEYLON_HOME}, it get's copied directly to the local copy of ceylon-distrelative to the ceylon-spec. Just to be exact.

@tombentley
Copy link
Member

What needs to be done here @lucaswerkmeister, @quintesse? Can we close this for 1.2 or should I move it to 1.3?

@lucaswerkmeister
Copy link
Member Author

I’ll try to get this done tonight.

@tombentley
Copy link
Member

Thanks

@quintesse
Copy link
Member

@lucaswerkmeister like before, if you need some help (especially with the redhat build stuff) just give a holler (Stef is the guy you want if you have questions about the debian stuff).

@lucaswerkmeister
Copy link
Member Author

The first part actually gets done automatically! :D generate-spec calls doc in ceylon-spec (which builds all formats, including info), and then copies all formats to dist/doc/en/spec, resulting in:

dist/doc/
└── en
    └── spec
        ├── html
        │   ├── annotations.html
        │   ├── declarations.html
        │   ├── execution.html
        │   ├── expressions.html
        │   ├── index.html
        │   ├── introduction.html
        │   ├── lexical.html
        │   ├── modulesystem.html
        │   ├── pr01.html
        │   ├── statementblocks.html
        │   └── typesystem.html
        ├── html_single
        │   └── index.html
        ├── info
        │   ├── ceylon-spec.info
        │   ├── ceylon-spec.info-1
        │   ├── ceylon-spec.info-2
        │   └── ceylon-spec.texi
        ├── pdf
        │   └── Ceylon Language Specification 20150917.pdf
        └── shared
            └── css
                ├── bnf.js
                ├── ceylon.css
                ├── ceylon.js
                ├── html.css
                └── rainbow.min.js

@FroMage
Copy link
Member

FroMage commented Oct 28, 2015

let me try it for debian

@FroMage
Copy link
Member

FroMage commented Oct 28, 2015

done for debian.

@quintesse
Copy link
Member

Well I added them and they get copied but it seems they don't get picked up by the "info" command, must have done something wrong.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants