Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 52911 - handbook-amd64.xml is misleading about amd64 CFLAGS
Summary: handbook-amd64.xml is misleading about amd64 CFLAGS
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs-user
Classification: Unclassified
Component: Handbook (show other bugs)
Hardware: AMD64 All
: High normal (vote)
Assignee: Docs Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2004-06-03 14:00 UTC by Danny van Dyk (RETIRED)
Modified: 2004-11-26 03:03 UTC (History)
1 user (show)

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


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Danny van Dyk (RETIRED) gentoo-dev 2004-06-03 14:00:42 UTC
The handbook gives a sample CFLAGS that is quite misleading if you interpret the handbook as amd64-specific. We had several users that used CFLAGS="-march=athlon-xp ...", which badly borked their system (miscompilation/segfaults/etc...). Could we please have arch-specific CFLAGS-samples ?
Further, could the handbook-amd64.xml please point to amd64.gentoo.org/technotes.xml and advise the users to read that before asking questions on ML and #gentoo-amd64 ? Thanks dudes !
Comment 1 Xavier Neys (RETIRED) gentoo-dev 2004-06-04 01:39:15 UTC
As mentioned in http://www.gentoo.org/doc/en/handbook/handbook-ppc.xml?part=1&chap=1#doc_chap1_sect4 a few references to foreign architectures will appear in the handbook because some chapters are common to all archs and minute differences do not justify an arch-specific chapter.

Besides, HB clearly states the example is for an x86 Athlon-XP ("For instance, for the x86 Athlon XP architecture:
Code Listing 16: The GCC march setting
-march=athlon-xp") and refers to the gcc man page and the make.conf.example file. The latter should definitely be updated to cover latest archs.
It appears in hb-install-stage.xml which is common to all archs. IMHO, it is not worth splitting but this is not my call.
Would a simple <comment># AMD64 users should not use athlon-xp</comment> in the code sample make you happy?

I have fixed the link in http://www.gentoo.org/doc/en/handbook/handbook-amd64.xml?part=1&chap=2#doc_chap1_sect2 to point to http://amd64.gentoo.org/technotes.xml as requested. It previously ended up on index.xml and only keen eyes would have noticed the link to the technotes from there.

Please mark bug as fixed or comment further. Thanks.
Comment 2 Danny van Dyk (RETIRED) gentoo-dev 2004-06-04 02:51:11 UTC
That additional comment would definitley make us happy ;-)
Please add it.
Comment 3 Xavier Neys (RETIRED) gentoo-dev 2004-06-04 03:12:33 UTC
Done. Please mark the bug as fixed if your are happy with the current solution.

May I suggest to create a new bug to have a comment about the AMD64 arch added to /etc/make.conf.example ?
Comment 4 Sven Vermeulen (RETIRED) gentoo-dev 2004-07-02 08:43:50 UTC
Marking this one as fixed (I hate open bugs)