Contributor Guide - Revision history

Smw: /* Building FreeM */

2025-04-29T22:30:49Z

Building FreeM

2025-04-29T22:24:56Z

Initial Build

2025-04-29T22:23:14Z

2025-04-05T22:32:46Z

C Standard

2025-04-05T22:31:43Z

C Standard

2025-04-05T22:17:07Z

When to run make install

2025-04-05T22:16:28Z

When to run autogen.sh

2025-04-05T22:16:12Z

When to run autogen.sh

2025-04-05T22:13:02Z

Building FreeM

2025-04-05T22:11:52Z

Building FreeM

← Older revision		Revision as of 22:30, 29 April 2025
Line 147:		Line 147:

	You will need to add any users who will use FreeM to the <code>freem</code> group, and log out and back in.		You will need to add any users who will use FreeM to the <code>freem</code> group, and log out and back in.
		+
		+	Once this is done, check the [[:Category:Platform Notes]] for your platform for further instructions about configuring your environment.

	Once you have done the initial build, most changes shouldn't require more than a <code>make</code>.		Once you have done the initial build, most changes shouldn't require more than a <code>make</code>.

@@ Line 145: / Line 145: @@
 # Create a <code>freem</code> user
 # Run <code>sudo fmadm configure</code>
 Once you have done the initial build, most changes shouldn't require more than a <code>make</code>.

@@ Line 142: / Line 142: @@
 # Run <code>make</code>
 # Run <code>sudo make install</code>
 Once you have done the initial build, most changes shouldn't require more than a <code>make</code>.

@@ Line 19: / Line 19: @@
 * Contributions should not break compiles on Sun <code>cc</code> or <code>clang</code>
-For the last two guidelines, FreeM core developers will test your contributions and work with you to address any incompatibilities with these older compilers. We do not require every contributor to have access to ever compiler.
+For the last two guidelines, FreeM core developers will test your contributions and work with you to address any incompatibilities with these older compilers. We do not require every contributor to have access to every compiler.
 ===Autotools===

@@ Line 16: / Line 16: @@
 * FreeM contributions must not use language features unavailable in C89
 * Vendor extensions in C compilers (like GNU extensions) are only permitted if guarded by preprocessor macros, and should be avoided if possible
-* Contributions must be backwards compatible with gcc 2.95.3 (the oldest compiler we support)
+* Contributions should be backwards compatible with gcc 2.95.3 (the oldest compiler we support)
-* Contributions must not break compiles on Sun <code>cc</code> or <code>clang</code>
+* Contributions should not break compiles on Sun <code>cc</code> or <code>clang</code>
 ===Autotools===

@@ Line 158: / Line 158: @@
 * You've changed the way the environment catalog (<code>env.conf</code>) or environment configuration files (<code>freem.conf</code>) work
 * You've modified a vendor routine in the <code>mlib/</code> directory
 Other than these scenarios, you should be able to run the <code>freem</code> and <code>fmadm</code> binaries out of the repository directory hierarchy.

@@ Line 147: / Line 147: @@
 ===When to run autogen.sh===
-The <code>autogen.sh</code> script is simply a shorthand for <code>autoreconf --install</code>. We recommend that FreeM hackers get used to using <code>autogen.sh</code> instead of running <code>autoreconf --install</code> directly, as <code>autogen.sh</code> may eventually contain other auto-generated items in future.
+The <code>autogen.sh</code> script is currently a shorthand for <code>autoreconf --install</code>.
 You will need to run <code>autogen.sh</code> only if you change any <code>configure.ac</code> or <code>Makefile.am</code> files. Even then, a fresh <code>make</code> will generally check to see if your generated autoconf/automake files are older than <code>configure.ac</code> or <code>Makefile.am</code> and do this step for you automatically.

← Older revision		Revision as of 22:13, 5 April 2025
Line 123:		Line 123:

	Note that the autotools <code>make install</code> will place FreeM in <code>/usr/local</code> by default on most platforms. This conflicts with binary packages on Solaris.		Note that the autotools <code>make install</code> will place FreeM in <code>/usr/local</code> by default on most platforms. This conflicts with binary packages on Solaris.
		+
		+	You can override the default installation location in the <code>configure</code> step with the following command:
		+
		+	<pre>
		+	$ ./configure --prefix=/path/to/desired/location
		+	</pre>

	==Initial Build==		==Initial Build==

← Older revision		Revision as of 22:11, 5 April 2025
Line 121:		Line 121:

	Please see [[:Category:Platform Notes]] for any additional notes unique to your platform.		Please see [[:Category:Platform Notes]] for any additional notes unique to your platform.
		+
		+	Note that the autotools <code>make install</code> will place FreeM in <code>/usr/local</code> by default on most platforms. This conflicts with binary packages on Solaris.

	==Initial Build==		==Initial Build==