Makefile Generator Reference Documentation

This directory contains comprehensive reference guides for generating production-ready Makefiles.

Quick Navigation

• Makefile Structure - File organization, layout, includes
• Variables Guide - Assignment operators, automatic variables, scope
• Targets Guide - Standard targets, .PHONY declarations, prerequisites
• Patterns Guide - Pattern rules, language-specific build patterns
• Optimization Guide - Parallel builds, caching, ccache integration
• Security Guide - Safe variable expansion, credential handling

Reading Order

For New Makefiles

1. Start with Makefile Structure to understand file organization
2. Read Variables Guide for variable assignment and scope
3. Review Targets Guide for standard GNU targets
4. Check Patterns Guide for your language (C/C++, Go, Python, Java)

For Production Makefiles

1. Read Optimization Guide for performance improvements
2. Review Security Guide for credential handling and safe practices

Common Lookup Tasks

Usage During Generation

When generating Makefiles, ALWAYS use the Read tool to consult relevant references before writing Makefile content. This ensures patterns are current and correctly applied.

Example workflow:

1. Read references/patterns-guide.md (find your language pattern)
2. Read references/security-guide.md (for Docker/deploy targets)
3. Generate Makefile combining patterns
4. Document which references were consulted in Makefile header