From 268c77c1b0cc5d82c894af6e3e4f040c1bd4644e Mon Sep 17 00:00:00 2001
From: Kevin Buettner <kevinb@redhat.com>
Date: Wed, 24 Feb 2021 14:35:07 -0700
Subject: Add comment regarding include order of <sys/ptrace.h> and
 <asm/ptrace.h>

gdb/ChangeLog:

	* nat/aarch64-linux-hw-point.c: Add comment regarding include
	order for <sys/ptrace.h> and <asm/ptrace.h>.
---
 gdb/nat/aarch64-linux-hw-point.c | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'gdb/nat')

diff --git a/gdb/nat/aarch64-linux-hw-point.c b/gdb/nat/aarch64-linux-hw-point.c
index 0278ac2..af2cc42 100644
--- a/gdb/nat/aarch64-linux-hw-point.c
+++ b/gdb/nat/aarch64-linux-hw-point.c
@@ -23,8 +23,15 @@
 #include "aarch64-linux-hw-point.h"
 
 #include <sys/uio.h>
+
+/* The order in which <sys/ptrace.h> and <asm/ptrace.h> are included
+   can be important.  <sys/ptrace.h> often declares various PTRACE_*
+   enums.  <asm/ptrace.h> often defines preprocessor constants for
+   these very same symbols.  When that's the case, build errors will
+   result when <asm/ptrace.h> is included before <sys/ptrace.h>.  */
 #include <sys/ptrace.h>
 #include <asm/ptrace.h>
+
 #include <elf.h>
 
 /* Number of hardware breakpoints/watchpoints the target supports.
-- 
cgit v1.1