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