Annotation of xenocara/README, Revision 1.23
1.1 matthieu 1:
2: Notes on building Xenocara for OpenBSD X hackers
3:
4: This document presents some techniques that can be useful for people
5: wanting to hack the xenocara tree. It assumes some basic knowledge of
6: the OpenBSD build system, as described in the release(8) manual page.
7:
8: o About Xenocara
9: --------------
1.11 david 10: Xenocara is the name chosen for OpenBSD's version of X. It's
1.22 matthieu 11: currently based on X.Org 7.3 and its dependencies. The goal of
1.1 matthieu 12: Xenocara is to provide a framework to host local modifications and to
13: automate the build of the modular X.Org components, including 3rd
1.11 david 14: party packages and some software maintained by OpenBSD developers.
1.1 matthieu 15:
16: o Source tree
17: -----------
18:
19: The organisation of the xenocara directory follows the general
20: organisation used in X.Org:
21:
22: - app: X applications and utilities
23: - data: various data files (keyboard mappings and bitmaps)
24: - doc: documentation
25: - driver: input and video drivers
26: - font: fonts
27: - lib: libraries
28: - proto: X protocol headers
29: - util: utilities that don't fit anywhere else
30: - xserver: the source for the X servers
31:
32: In addition Xenocara uses the following directories:
33:
34: - dist: contains the Mesa sources, shared by lib and xserver above
35: - distrib: all binary distribution related tools and data
36: - etc: mtree(8) data files
1.3 matthieu 37: - share: make(1) configuration for Xenocara
1.1 matthieu 38:
1.2 matthieu 39: At the top-level directory two files describe the individual
1.3 matthieu 40: components of Xenocara:
1.1 matthieu 41:
1.2 matthieu 42: - MODULES lists all X.Org components (imported from the X.Org
43: distribution at http://xorg.freedesktop.org/archive/)
1.3 matthieu 44: - 3RDPARTY lists all 3rd party software components provided in Xenocara,
1.2 matthieu 45: either as dependencies of the X.Org software, or as
46: complements to it to provide a more useable default
47: environment.
48:
49: o Compiling and installing
50: ------------------------
51:
1.3 matthieu 52: Xenocara is made up of more than three hundred different
1.20 jolan 53: independent packages that need to be built and installed in the right
1.3 matthieu 54: order, especially while bootstrapping (while /usr/X11R6 is still
55: empty). The Xenocara Makefiles take care of that using the 'build'
1.2 matthieu 56: target.
57:
1.5 matthieu 58: Quick startup guide
59:
60: The following steps will build and install everything for the first time.
61:
1.7 matthieu 62: cd xenocara
1.5 matthieu 63: make bootstrap
64: make obj
65: make build
66:
67: If you want to use another obj directory see below.
68:
1.2 matthieu 69: Requirements
70:
71: A freshly checked out xenocara tree is buildable without any external
1.23 ! matthieu 72: tool. Only the xenocara and the src (currently only the
! 73: src/sys/dev/pci/pcidevs file) trees are needed.
! 74:
! 75: However if you start modifying things in the automake build
1.2 matthieu 76: system used by many packages, you will need to have the following
1.3 matthieu 77: GNU autotools packages installed:
1.2 matthieu 78:
79: - automake 1.9 (devel/automake/1.9)
80: - autoconf 2.59 (devel/autoconf/2.59)
1.6 matthieu 81: - metaauto 0.6 (or later) (devel/metaauto)
1.2 matthieu 82: - libtool 1.5.22 (or later) (devel/libtool)
83:
1.17 matthieu 84: If you have your source tree on an NFS partition, make sure the clock
1.23 ! matthieu 85: of your server and client are properly synchronised. Any significant
! 86: drift will cause various problems during builds.
1.17 matthieu 87:
1.8 matthieu 88: Path
89:
90: To build Xenocara, you need to have /usr/X11R6/bin in your PATH.
91:
1.2 matthieu 92: Sudo
93:
94: If the SUDO variable points to your sudo(8) binary in /etc/mk.conf,
95: 'make build' can be run as a normal user. It will raise its privileges
96: whenever needed with sudo. Otherwise, you need to run make build as
97: root.
98:
1.3 matthieu 99: If you have installed the full Xenocara X sets on your system, you
100: don't need to build all of Xenocara to patch one element. You can go
1.2 matthieu 101: to any module sub-directory and run 'make build' from there.
102:
1.8 matthieu 103: Source directory
104:
105: The variable XSRCDIR can be set either in the environment or in
1.9 matthieu 106: /etc/mk.conf to point to the xenocara source tree, in case you keep it
1.21 matthieu 107: in a non-standard directory (the default is /usr/xenocara).
1.8 matthieu 108:
1.2 matthieu 109: Objdirs
110:
111: Xenocara supports objdirs (and it's even the recommended way to build
112: things). Just run 'make obj' at any level before 'make build' to make
1.4 matthieu 113: sure that the object directories are created.
1.13 matthieu 114: XOBJDIR defines the obj directory that is used (defaults to /usr/xobj).
115: It should be created before running 'make obj'.
1.2 matthieu 116:
117: Shadow trees
118:
119: Alternatively, the old 'lndir(1)' method can still be used to build
1.3 matthieu 120: Xenocara outside of its source tree. Just don't use 'make obj' in this
1.2 matthieu 121: case.
122:
123: o Regenerating configure scripts
124: ------------------------------
125:
126: Whenever you touched an import file for GNU autotools (Makefile.am,
127: configure.ac mostly), you need to rebuild the configure script and
1.14 matthieu 128: makefiles skeletons. For that use the following command in the
129: directory where you edited the autotools source files:
1.2 matthieu 130:
131: env XENOCARA_RERUN_AUTOCONF=Yes make -f Makefile.bsd-wrapper build
132:
1.14 matthieu 133: You can also set XENOCARA_RERUN_AUTOCONF in /etc/mk.conf or in the
134: environment to force the regeneration of configure scripts
135: in every component during a make build.
1.2 matthieu 136:
1.15 matthieu 137: o Cleaning in packages managed by autotools
138: -----------------------------------------
139:
140: One common problem when building xenocara is the case where the obj
141: directory didn't exist (or the symbolic link pointed to a non-existent
1.16 matthieu 142: directory) when the source was first built. After fixing this problem,
1.15 matthieu 143: 'configure' will refuse to work in the obj dir, because the source
144: is already configured.
145:
146: To recover from this in one package:
147:
148: rm -f obj
149: make -f Makefile.bsd-wrapper cleandir
150: mkdir XOBJDIR
151: make -f Makefile.bsd-wrapper obj
152: make -f Makefile.bsd-wrapper build
153:
154: or from the root of the xenocara tree:
155:
156: find . -type l -name obj | xargs rm -f
157: make cleandir
158: mkdir XOBJDIR
159: make obj
160: make build
161:
1.16 matthieu 162: for more desperate cases, remove all files from XSRCDIR not in CVS:
1.15 matthieu 163:
164: cd XSRCDIR
165: cvs -q update -PAd -I - | awk '$1=="?" {print $2}' | xargs rm -f
166:
1.19 matthieu 167: o How to build something with debug information?
168: ----------------------------------------------
169:
170: You can use "env CFLAGS=-g make -f Makefile.bsd-wrapper build" to
171: build any module with debugging information, but you'll need to remove
172: XOBJDIR/xorg-config.cache.${MACHINE} before doing that because
173: autoconf caches the value of CFLAGS in its cache.
174:
175: o How to get a core file out of the X server?
176: -------------------------------------------
177:
178: Several things are needed:
179:
180: 1) set kern.nosuidcoredump=2 in /etc/sysctl.conf
181: 2) put
182:
183: Option "NoTrapSignals" "true"
184:
185: in the "ServerFlags" section of /etc/X11/xorg.conf. If such a section
186: doesn't exist, it can be added as follow:
187:
188: Section "ServerFlags"
189: Option "NoTrapSignals" "true"
190: EndSection
191:
192: anywhere in the configuration file.
193:
194: 3) start the X server as root, with the -keepPriv option. A regular
195: user is not allowed to use this option. If you use xdm, you can add
196: the option in /etc/X11/xdm/Xservers. If you want to use startx, you
197: need to run it as root, like this:
198:
199: startx -- /usr/X11R6/bin/X -keepPriv
200:
201: Now the X server will dump core when catching a fatal signal. But it
202: will also not be able to restore the text mode on exit. So be prepared
203: to log in remotely (serial terminal or ssh) to reboot your machine or
204: to restart X.
205:
206: The core dump will be in /var/crash.
207:
208: See also <http://xorg.freedesktop.org/wiki/Development/Documentation/ServerDebugging>
209:
1.15 matthieu 210: --
1.23 ! matthieu 211: $OpenBSD: README,v 1.22 2008/03/13 20:34:19 matthieu Exp $
![[BACK]](/icons/back.gif){kind=icon}
Return to README CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / xenocara