Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 189406 - Emacs XFT support could have better user docs
Summary: Emacs XFT support could have better user docs
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Project-specific documentation (show other bugs)
Hardware: All All
: High enhancement (vote)
Assignee: Emacs project
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-08-18 21:19 UTC by Thomas Nichols
Modified: 2007-08-22 07:23 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
First draft user doc for Emacs XFT with emacs-cvs-23 (gentoo-emacs-xft-doc.xml,2.52 KB, text/plain)
2007-08-18 21:47 UTC, Thomas Nichols
Details
emacs-xft.xml (emacs-xft.xml,2.71 KB, text/plain)
2007-08-19 23:02 UTC, nm (RETIRED)
Details
emacs-xft.xml (emacs-xft.xml,2.54 KB, text/plain)
2007-08-19 23:44 UTC, Ulrich Müller
Details
emacs-xft.xml (emacs-xft.xml,3.00 KB, text/plain)
2007-08-20 00:08 UTC, nm (RETIRED)
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Thomas Nichols 2007-08-18 21:19:51 UTC
Emacs XFT support gives antialiased fonts -- but this is only available in app-editors/emacs-cvs-23*, and the process of getting it working requires knowledge of handling package masking, specifying package.use etc. After discussions with Christian Faulhammer (devname:opfer, forum handle:V-Li, who asked me to file this bug) of the Gentoo Lisp project - http://forums.gentoo.org/viewtopic-t-572709.html - here's a quick intro document in guideXML that could perhaps be used as a starting point.

Reproducible: Always

Steps to Reproduce:
1. N/A
2.
3.

Actual Results:  
N/A

Expected Results:  
N/A

N/A
Comment 1 Thomas Nichols 2007-08-18 21:47:23 UTC
Created attachment 128495 [details]
First draft user doc for Emacs XFT with emacs-cvs-23

(I'm away for a week so will pick up suggested changes on my return).
Comment 2 Ulrich Müller gentoo-dev 2007-08-19 05:51:35 UTC
(In reply to comment #1)
> Created an attachment (id=128495) [edit]
> First draft user doc for Emacs XFT with emacs-cvs-23

Thank you for posting this, looks good. Now we have to find a place where it could go.

Two minor points:
1. The part about installation of eselect is not necessary since it is in
   the dependency chain and you will get it automatically.
2. I wouldn't mention the "toolkit-scroll-bars" USE flag; it is unrelated
   to fonts.
Comment 3 nm (RETIRED) gentoo-dev 2007-08-19 09:03:56 UTC
No need to CC the GDP for this; we're not in charge of project-specific docs...those go in the appropriate /proj/en/ dir. Not our responsibility.

However, I'm CCing myself. This document needs considerable GuideXML coding style changes, so I'll post a revised version real soon.
Comment 4 Ulrich Müller gentoo-dev 2007-08-19 09:41:48 UTC
(In reply to comment #3)
> No need to CC the GDP for this; we're not in charge of project-specific
> docs...those go in the appropriate /proj/en/ dir. Not our responsibility.

Hm, I'm not sure if a future Emacs user guide should go to the Emacs project pages, since the nano and vi guides are both located at <http://www.gentoo.org/doc/en/index.xml?catid=desktop>.
Comment 5 nm (RETIRED) gentoo-dev 2007-08-19 23:02:49 UTC
Created attachment 128617 [details]
emacs-xft.xml

A proper version of the suggested doc fragment, with proper GuideXML, coding style, etc. Note that we have no such tag as <code>; dunno where the author came up with that.

Also, note that this is still NOT A COMPLETE GUIDEXML PAGE. This is only a <section> or two that must fit inside of a complete page; it's analogous to an HTML having a few <p> tags but without critical things such as <html> or <head> -- there needs to be a complete document to which this is just a part. You (or someone else) will need to write up a complete document to put this in.

Also, it will not be going into the /doc/en/ repository, ever. Not because we hate emacs (vim ftw!! :D), but because it involves recommending masked, ~arch, CVS, and otherwise unstable software versions. That is something we cannot ever recommend to our users, not in good conscience. So for now it should belong in the emacs project space in /proj/en/, assuming you guys have one (you should!).

Anyway, it's fixed, etc. I took out useless stuff like ~x86 keywords, as Portage doesn't need them, and that only looks bad for all other arches when you pick and choose just one.

Also, I removed the bit about unmasking eselect-emacs, as there is no masked or ~arch version; the latest (1.1) is stable for all arches. I also replaced emerge eselect with the proper emerge eselect-emacs command, as that will pull in the required module along with eselect.

I also removed the link to the Gentoo wiki. 1) the wiki is neither controlled by, supported by, endorsed or otherwise recommended by Gentoo developers. and 2) it doesn't seem to exist anymore. Oh well; we're not responsible for their lack of QA anyway. I did leave in the other link, though.
Comment 6 Ulrich Müller gentoo-dev 2007-08-19 23:44:26 UTC
Created attachment 128625 [details]
emacs-xft.xml

Thanks Josh. Concerning content, some more changes:
- x11-misc/emacs-desktop is also stable on all relevant archs, so it is not
  necessary to put it into package.keywords.
- eselect-emacs and emacs-desktop are pulled in as dependencies of emacs and
  therefore need not be explicitely emerged.
Comment 7 nm (RETIRED) gentoo-dev 2007-08-20 00:08:16 UTC
Created attachment 128627 [details]
emacs-xft.xml

Created this before I noticed that ulm attached his. Fortunately, we had the same fixes, because I realized that I forgot to include his fixes on stuff that doesn't need to be keyworded/unmasked/installed.

Anyway, this is a complete document, ready to go into /proj/en/lisp/emacs/ -- just be sure to update your project index.xml page to mention and link the doc.
Comment 8 Ulrich Müller gentoo-dev 2007-08-22 07:23:47 UTC
(In reply to comment #7)
> Created an attachment (id=128627) [edit]
> emacs-xft.xml

> Anyway, this is a complete document, ready to go into /proj/en/lisp/emacs/

In CVS, see <http://www.gentoo.org/proj/en/lisp/emacs/xft.xml>

Marking as RESOLVED; feel free to reopen this bug if something is still wrong or missing.