[cronet] make startNetLogToFile write to correct file

components/cronet/ios/Cronet.h

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import <Foundation/Foundation.h>
 
 #include "cronet_c_for_grpc.h"
 
 // A block, that takes a request, and returns YES if the request should
 // be handled.
@@ skipping 55 matching lines @@
 // This method must be called after |start|.
 + (void)unregisterHttpProtocolHandler;
 
 // Installs Cronet into NSURLSessionConfiguration so that all
 // NSURLSessions created with this configuration will use the Cronet stack.
 // Note that all Cronet settings are global and are shared between
 // all NSURLSessions & NSURLConnections that use the Cronet stack.
 // This method must be called after |start|.
 + (void)installIntoSessionConfiguration:(NSURLSessionConfiguration*)config;
 
-// Starts net-internals logging to a file named |fileName| in the application
-// temporary directory. |fileName| must not be empty. Log level is determined
-// by |logBytes| - if YES then LOG_ALL otherwise LOG_ALL_BUT_BYTES. If the file
-// exists it is truncated before starting. If actively logging the call is
-// ignored.
-+ (void)startNetLogToFile:(NSString*)fileName logBytes:(BOOL)logBytes;
+// Starts net-internals logging to a file named |fileName|. If |fileName| is
+// relative, it puts it in the application home directory. |fileName| must not

[kapishnikov, 2016/11/18 22:17:27]

Usually iOS documentation refers to 'documents' and 'temp' directory. These are
the directories where app has permissions to write to. I would assume that the
'home' directory is the root directory of the app where the app has no
permission. I think we should reference the documents directory here.

[lilyhoughton, 2016/11/22 20:48:42]

Done.

+// be empty. Log level is determined by |logBytes| - if YES then LOG_ALL
+// otherwise LOG_ALL_BUT_BYTES. If the file exists it is truncated before

[kapishnikov, 2016/11/18 22:17:27]

It is not clear what LOG_ALL_BUT_BYTES mean here. Is it a constant defined
somewhere else?

[lilyhoughton, 2016/11/22 20:48:42]

It doesn't appear to refer to a constant used by the NetLog functions, and I'm
not familiar enough with the code that logBytes affects yet to know what it's
referring to.

+// starting. If actively logging the call is ignored.
++ (BOOL)startNetLogToFile:(NSString*)fileName logBytes:(BOOL)logBytes;
 
 // Stop net-internals logging and flush file to disk. If a logging session is
 // not in progress this call is ignored.
 + (void)stopNetLog;
 
 // Returns the full user-agent that the stack uses.
 // This is the exact string servers will see.
 + (NSString*)getUserAgent;
 
 // Get a pointer to global instance of cronet_engine for GRPC C API.
@@ skipping 10 matching lines @@
 
 // Sets Host Resolver Rules for testing.
 // This method only has any effect before |start| is called.
 + (void)setHostResolverRulesForTesting:(NSString*)hostResolverRulesForTesting;
 
 // Enables TestCertVerifier which accepts all certificates for testing.
 // This method only has any effect before |start| is called.
 + (void)enableTestCertVerifierForTesting;
 
 @end