Add comment for ParseMemoryMapFromScanner

profile/legacy_profile.go

@@ -1015,6 +1015,10 @@ func (p *Profile) ParseMemoryMap(rd io.Reader) error {
 	return p.ParseMemoryMapFromScanner(bufio.NewScanner(rd))
 }
 
+// ParseMemoryMapFromScanner parses a memory map in the format of
+// /proc/self/maps or a variety of legacy format, and overrides the
+// mappings in the current profile.  It renumbers the samples and
+// locations in the profile correspondingly.
 func (p *Profile) ParseMemoryMapFromScanner(s *bufio.Scanner) error {
 	mapping, err := parseProcMapsFromScanner(s)
 	if err != nil {